blob: 0bc18f1261484e4f8ff8b6ea762cbb5604c6bf4d [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
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
135 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200278#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (src->ticket != NULL) {
280 dst->ticket = mbedtls_calloc(1, src->ticket_len);
281 if (dst->ticket == NULL) {
282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
283 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000287
288#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
289 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
293 if (ret != 0) {
294 return ret;
295 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000296 }
297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
298 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200299#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200302}
303
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500304#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
309 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800310 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312
313 /* We want to copy len_new bytes when downsizing the buffer, and
314 * len_old bytes when upsizing, so we choose the smaller of two sizes,
315 * to fit one buffer into another. Size checks, ensuring that no data is
316 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 memcpy(resized_buffer, *buffer,
318 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100319 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 *buffer = resized_buffer;
322 *len_old = len_new;
323
324 return 0;
325}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200326
Gilles Peskine449bd832023-01-11 14:50:10 +0100327static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
328 size_t in_buf_new_len,
329 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200330{
331 int modified = 0;
332 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
333 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl->in_buf_len < in_buf_new_len) {
341 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
343 } else {
344 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
345 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 modified = 1;
347 }
348 }
349 }
350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200352 written_out = ssl->out_msg - ssl->out_buf;
353 iv_offset_out = ssl->out_iv - ssl->out_buf;
354 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 ssl->out_buf_len < out_buf_new_len) {
358 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
360 } else {
361 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
362 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 modified = 1;
364 }
365 }
366 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 /* Fields below might not be properly updated with record
371 * splitting or with CID, so they are manually updated here. */
372 ssl->out_msg = ssl->out_buf + written_out;
373 ssl->out_len = ssl->out_buf + len_offset_out;
374 ssl->out_iv = ssl->out_buf + iv_offset_out;
375
376 ssl->in_msg = ssl->in_buf + written_in;
377 ssl->in_len = ssl->in_buf + len_offset_in;
378 ssl->in_iv = ssl->in_buf + iv_offset_in;
379 }
380}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500381#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
382
Jerry Yudb8c48a2022-01-27 14:54:54 +0800383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800384
385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100386typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
387 const char *label,
388 const unsigned char *random, size_t rlen,
389 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800390
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
394
395/* Type for the TLS PRF */
396typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
397 const unsigned char *, size_t,
398 unsigned char *, size_t);
399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
402 int ciphersuite,
403 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200406#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 ssl_tls_prf_t tls_prf,
408 const unsigned char randbytes[64],
409 mbedtls_ssl_protocol_version tls_version,
410 unsigned endpoint,
411 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100413#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300416 const char *label,
417 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100419static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
420static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100421
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425MBEDTLS_CHECK_RETURN_CRITICAL
426static int tls_prf_sha384(const unsigned char *secret, size_t slen,
427 const char *label,
428 const unsigned char *random, size_t rlen,
429 unsigned char *dstbuf, size_t dlen);
430
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
435static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
436 unsigned char *buf,
437 size_t buf_len);
438
439MBEDTLS_CHECK_RETURN_CRITICAL
440static int ssl_tls12_session_load(mbedtls_ssl_session *session,
441 const unsigned char *buf,
442 size_t len);
443#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
444
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100445static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100451#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100452static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100453#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100454
455int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
456 const unsigned char *secret, size_t slen,
457 const char *label,
458 const unsigned char *random, size_t rlen,
459 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300460{
461 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
462
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300466 case MBEDTLS_SSL_TLS_PRF_SHA384:
467 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100469#endif /* MBEDTLS_MD_CAN_SHA384*/
470#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471 case MBEDTLS_SSL_TLS_PRF_SHA256:
472 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100474#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 default:
477 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478 }
479
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481}
482
Jerry Yuc73c6182022-02-08 20:29:25 +0800483#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100484static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800485{
486#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 if (session->peer_cert != NULL) {
488 mbedtls_x509_crt_free(session->peer_cert);
489 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 session->peer_cert = NULL;
491 }
492#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800494 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800496 session->peer_cert_digest = NULL;
497 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
498 session->peer_cert_digest_len = 0;
499 }
500#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
501}
502#endif /* MBEDTLS_X509_CRT_PARSE_C */
503
Gilles Peskine449bd832023-01-11 14:50:10 +0100504uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800505{
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800507 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800509
510 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100511 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800512
513 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800515
516 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800518
519 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
Jan Bruckner151f6422023-02-10 12:45:19 +0100585 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
586 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
587
Jerry Yu7a485c12022-10-31 13:08:18 +0800588 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
591 }
592
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800594}
595
Gilles Peskine449bd832023-01-11 14:50:10 +0100596uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800597{
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800599}
600
Jerry Yud25cab02022-10-31 12:48:30 +0800601#if defined(MBEDTLS_DEBUG_C)
602static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800603 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800604 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
605 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
606 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
607 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
608 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
609 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
610 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
611 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
612 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
613 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
615 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
616 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
617 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
619 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
620 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
621 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
622 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
623 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
624 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
625 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
626 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
627 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
628 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
629 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100630 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
631 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800632};
633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800635 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
636 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
637 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
638 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
639 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
640 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
641 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
642 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
643 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
644 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
645 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
647 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
648 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
649 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
651 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
652 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
653 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
654 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
655 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
656 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
657 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
658 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
659 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
660 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
661 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100662 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
663 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800664};
665
Gilles Peskine449bd832023-01-11 14:50:10 +0100666const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800667{
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 return extension_name_table[
669 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800670}
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800673{
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800691}
692
Gilles Peskine449bd832023-01-11 14:50:10 +0100693void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
694 int level, const char *file, int line,
695 int hs_msg_type, unsigned int extension_type,
696 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800697{
698 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800700 mbedtls_debug_print_msg(
701 ssl, level, file, line,
702 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 ssl_tls13_get_hs_msg_name(hs_msg_type),
704 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800705 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800707 return;
708 }
709
710 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800712 mbedtls_debug_print_msg(
713 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type), extension_type,
716 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800717 return;
718 }
719
720 mbedtls_debug_print_msg(
721 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
723 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800724}
725
Gilles Peskine449bd832023-01-11 14:50:10 +0100726void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
727 int level, const char *file, int line,
728 int hs_msg_type, uint32_t extensions_mask,
729 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800730{
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 for (unsigned i = 0;
733 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
734 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800735 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800736 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800738 }
739}
740
Pengyu Lvee455c02023-01-12 14:37:24 +0800741#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800742static const char *ticket_flag_name_table[] =
743{
744 [0] = "ALLOW_PSK_RESUMPTION",
745 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
746 [3] = "ALLOW_EARLY_DATA",
747};
748
Pengyu Lv4938a562023-01-16 11:28:49 +0800749void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
750 int level, const char *file, int line,
751 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800752{
753 size_t i;
754
755 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800756 "print ticket_flags (0x%02x)", flags);
757
758 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800759
760 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800761 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800762 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
763 ticket_flag_name_table[i]);
764 }
765 }
766}
767#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
768
Jerry Yud25cab02022-10-31 12:48:30 +0800769#endif /* MBEDTLS_DEBUG_C */
770
Gilles Peskine449bd832023-01-11 14:50:10 +0100771void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
772 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800773{
774 ((void) ciphersuite_info);
775
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100776#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800778 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800780#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100781#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800783 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800785#endif
786 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 return;
789 }
790}
791
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100792int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100793 unsigned hs_type,
794 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100795{
796 unsigned char hs_hdr[4];
797
798 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
800 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
801 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
802 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100803
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100804 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805}
806
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100807int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100808 unsigned hs_type,
809 unsigned char const *msg,
810 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100812 int ret;
813 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100816 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100818}
819
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100820int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800821{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100822#if defined(MBEDTLS_MD_CAN_SHA256) || \
823 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100824#if defined(MBEDTLS_USE_PSA_CRYPTO)
825 psa_status_t status;
826#else
827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
828#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100829#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800830 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100831#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100832#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800833#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
835 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200836 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837 }
838 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
839 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200840 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100841 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800842#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100843 mbedtls_md_free(&ssl->handshake->fin_sha256);
844 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100845 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
846 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
847 0);
848 if (ret != 0) {
849 return ret;
850 }
851 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 if (ret != 0) {
853 return ret;
854 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800855#endif
856#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100857#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100859 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
863 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
864 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200865 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100866 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800867#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100868 mbedtls_md_free(&ssl->handshake->fin_sha384);
869 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100870 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
871 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
872 if (ret != 0) {
873 return ret;
874 }
875 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100876 if (ret != 0) {
877 return ret;
878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#endif
880#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100881 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800882}
883
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100885 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800886{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100887#if defined(MBEDTLS_MD_CAN_SHA256) || \
888 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100889#if defined(MBEDTLS_USE_PSA_CRYPTO)
890 psa_status_t status;
891#else
892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
893#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100894#else /* SHA-256 or SHA-384 */
895 ((void) ssl);
896 (void) buf;
897 (void) len;
898#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100899#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800900#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100901 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
902 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200903 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100904 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800905#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100906 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100907 if (ret != 0) {
908 return ret;
909 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800910#endif
911#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100912#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800913#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100914 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
915 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200916 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100917 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800918#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100919 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100920 if (ret != 0) {
921 return ret;
922 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800923#endif
924#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800926}
927
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100928#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100929static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100930 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800931{
932#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200933 return mbedtls_md_error_from_psa(psa_hash_update(
934 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800935#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100936 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800937#endif
938}
939#endif
940
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100941#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100942static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100943 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800944{
945#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200946 return mbedtls_md_error_from_psa(psa_hash_update(
947 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100949 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800950#endif
951}
952#endif
953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200955{
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200957
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100958#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500959#if defined(MBEDTLS_USE_PSA_CRYPTO)
960 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500961#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100962 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100965#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500966#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500967 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500968#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100969 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200970#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500971#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200972
973 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200978#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200979 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200982#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200983#if defined(MBEDTLS_USE_PSA_CRYPTO)
984 handshake->psa_pake_ctx = psa_pake_operation_init();
985 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
986#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200988#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200989#if defined(MBEDTLS_SSL_CLI_C)
990 handshake->ecjpake_cache = NULL;
991 handshake->ecjpake_cache_len = 0;
992#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200993#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200994
Gilles Peskineeccd8882020-03-10 12:19:08 +0100995#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200997#endif
998
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200999#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1000 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1001#endif
Hanno Becker75173122019-02-06 16:18:31 +00001002
1003#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1004 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001006#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001007}
1008
Gilles Peskine449bd832023-01-11 14:50:10 +01001009void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001010{
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001012
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001013#if defined(MBEDTLS_USE_PSA_CRYPTO)
1014 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1015 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001016#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1018 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001019#endif
1020
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001021#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001022#if defined(MBEDTLS_USE_PSA_CRYPTO)
1023 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1024 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 mbedtls_md_init(&transform->md_ctx_enc);
1027 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001028#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001029#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001030}
1031
Gilles Peskine449bd832023-01-11 14:50:10 +01001032void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001033{
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001035}
1036
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001037MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001038static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001039{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1041
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001042 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001043#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->transform_negotiate) {
1045 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1046 }
Jerry Yu2e199812022-12-01 18:57:19 +08001047#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 if (ssl->session_negotiate) {
1049 mbedtls_ssl_session_free(ssl->session_negotiate);
1050 }
1051 if (ssl->handshake) {
1052 mbedtls_ssl_handshake_free(ssl);
1053 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001054
Jerry Yu2e199812022-12-01 18:57:19 +08001055#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001056 /*
1057 * Either the pointers are now NULL or cleared properly and can be freed.
1058 * Now allocate missing structures.
1059 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->transform_negotiate == NULL) {
1061 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001062 }
Jerry Yu2e199812022-12-01 18:57:19 +08001063#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->session_negotiate == NULL) {
1066 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Paul Bakker48916f92012-09-16 19:57:18 +00001068
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (ssl->handshake == NULL) {
1070 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001071 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001072#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1073 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1076 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001077#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001078
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001079 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001081#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001082 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001083#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 ssl->session_negotiate == NULL) {
1085 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001086
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089
1090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001093#endif
1094
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001096 ssl->session_negotiate = NULL;
1097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001099 }
1100
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001101 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_ssl_session_init(ssl->session_negotiate);
1103 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001104
Jerry Yu2e199812022-12-01 18:57:19 +08001105#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001107#endif
1108
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001109 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001110 ret = mbedtls_ssl_reset_checksum(ssl);
1111 if (ret != 0) {
1112 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1113 return ret;
1114 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001115
Jerry Yud0766ec2022-09-22 10:46:57 +08001116#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1117 defined(MBEDTLS_SSL_SRV_C) && \
1118 defined(MBEDTLS_SSL_SESSION_TICKETS)
1119 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001121#endif
1122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001125 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001126
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001128 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001130 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001135#endif
1136
Brett Warrene0edc842021-08-17 09:53:13 +01001137/*
1138 * curve_list is translated to IANA TLS group identifiers here because
1139 * mbedtls_ssl_conf_curves returns void and so can't return
1140 * any error codes.
1141 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001142#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001143#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1144 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001146 size_t length;
1147 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1148
Thomas Daubney850a0792023-05-22 12:05:03 +01001149 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 }
Brett Warrene0edc842021-08-17 09:53:13 +01001151
1152 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1154 if (group_list == NULL) {
1155 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1156 }
Brett Warrene0edc842021-08-17 09:53:13 +01001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001159 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 curve_list[i]);
1161 if (tls_id == 0) {
1162 mbedtls_free(group_list);
1163 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001164 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001165 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001166 }
1167
1168 group_list[length] = 0;
1169
1170 ssl->handshake->group_list = group_list;
1171 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001173 ssl->handshake->group_list = ssl->conf->group_list;
1174 ssl->handshake->group_list_heap_allocated = 0;
1175 }
1176#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001177#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001178
Ronald Crone68ab4f2022-10-05 12:46:29 +02001179#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001180#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001181#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001182 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1183 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1185 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001186 const int *md;
1187 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001188 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001189 uint16_t *p;
1190
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001191 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1192 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1193 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001194
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1196 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001197 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001199#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001201#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001202
Jerry Yub476a442022-01-21 18:14:45 +08001203#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001205#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1207 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1208 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001209 }
1210
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1212 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1213 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1216 sizeof(uint16_t));
1217 if (ssl->handshake->sig_algs == NULL) {
1218 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 p = (uint16_t *) ssl->handshake->sig_algs;
1222 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1223 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1224 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001225 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001227#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001229 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001230#endif
1231#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001233 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001234#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001236 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001237 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001239#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 ssl->handshake->sig_algs_heap_allocated = 0;
1242 }
Jerry Yucc539102022-06-27 16:27:35 +08001243#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001244#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001246}
1247
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001248#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001249/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001250MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001251static int ssl_cookie_write_dummy(void *ctx,
1252 unsigned char **p, unsigned char *end,
1253 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001254{
1255 ((void) ctx);
1256 ((void) p);
1257 ((void) end);
1258 ((void) cli_id);
1259 ((void) cli_id_len);
1260
Gilles Peskine449bd832023-01-11 14:50:10 +01001261 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001262}
1263
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001264MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001265static int ssl_cookie_check_dummy(void *ctx,
1266 const unsigned char *cookie, size_t cookie_len,
1267 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268{
1269 ((void) ctx);
1270 ((void) cookie);
1271 ((void) cookie_len);
1272 ((void) cli_id);
1273 ((void) cli_id_len);
1274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001276}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001277#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278
Paul Bakker5121ce52009-01-03 21:22:43 +00001279/*
1280 * Initialize an SSL context
1281 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001282void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001283{
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001285}
1286
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001288static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001289{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001290 const mbedtls_ssl_config *conf = ssl->conf;
1291
Ronald Cron6f135e12021-12-08 16:57:54 +01001292#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1294 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1295 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001297 }
1298
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1300 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001301 }
1302#endif
1303
1304#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1306 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1307 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001308 }
1309#endif
1310
Ronald Cron6f135e12021-12-08 16:57:54 +01001311#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1313 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1314 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1315 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001316 }
1317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1319 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001320 }
1321#endif
1322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1324 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001325}
1326
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001327MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001328static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1329{
1330 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 ret = ssl_conf_version_check(ssl);
1332 if (ret != 0) {
1333 return ret;
1334 }
Jerry Yu60835a82021-08-04 10:13:52 +08001335
Jerry Yudef7ae42022-10-30 14:13:19 +08001336#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1337 /* RFC 8446 section 4.4.3
1338 *
1339 * If the verification fails, the receiver MUST terminate the handshake with
1340 * a "decrypt_error" alert.
1341 *
1342 * If the client is configured as TLS 1.3 only with optional verify, return
1343 * bad config.
1344 *
1345 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001346 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001348 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1349 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1350 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001352 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 1, ("Optional verify auth mode "
1354 "is not available for TLS 1.3 client"));
1355 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001356 }
1357#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1358
Jerry Yu60835a82021-08-04 10:13:52 +08001359 /* Space for further checks */
1360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001362}
1363
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001364/*
1365 * Setup an SSL context
1366 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001367
Gilles Peskine449bd832023-01-11 14:50:10 +01001368int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1369 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001370{
Janos Follath865b3eb2019-12-16 11:46:15 +00001371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001372 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1373 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001374
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001375 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 if ((ret = ssl_conf_check(ssl)) != 0) {
1378 return ret;
1379 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001380 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001381
Paul Bakker62f2dee2012-09-28 07:31:51 +00001382 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001383 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001384 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001385
1386 /* Set to NULL in case of an error condition */
1387 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001388
Darryl Greenb33cc762019-11-28 14:29:44 +00001389#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1390 ssl->in_buf_len = in_buf_len;
1391#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1393 if (ssl->in_buf == NULL) {
1394 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001395 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001396 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001397 }
1398
Darryl Greenb33cc762019-11-28 14:29:44 +00001399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1400 ssl->out_buf_len = out_buf_len;
1401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1403 if (ssl->out_buf == NULL) {
1404 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001405 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001406 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001407 }
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001410
Johan Pascalb62bb512015-12-03 21:56:45 +01001411#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001413#endif
1414
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001416 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001420
1421error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 mbedtls_free(ssl->in_buf);
1423 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001424
1425 ssl->conf = NULL;
1426
Darryl Greenb33cc762019-11-28 14:29:44 +00001427#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1428 ssl->in_buf_len = 0;
1429 ssl->out_buf_len = 0;
1430#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001431 ssl->in_buf = NULL;
1432 ssl->out_buf = NULL;
1433
1434 ssl->in_hdr = NULL;
1435 ssl->in_ctr = NULL;
1436 ssl->in_len = NULL;
1437 ssl->in_iv = NULL;
1438 ssl->in_msg = NULL;
1439
1440 ssl->out_hdr = NULL;
1441 ssl->out_ctr = NULL;
1442 ssl->out_len = NULL;
1443 ssl->out_iv = NULL;
1444 ssl->out_msg = NULL;
1445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001447}
1448
1449/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001450 * Reset an initialized and used SSL context for re-use while retaining
1451 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001452 *
1453 * If partial is non-zero, keep data in the input buffer and client ID.
1454 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001456void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1457 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458{
Darryl Greenb33cc762019-11-28 14:29:44 +00001459#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1460 size_t in_buf_len = ssl->in_buf_len;
1461 size_t out_buf_len = ssl->out_buf_len;
1462#else
1463 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1464 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1465#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001466
Hanno Beckerb0302c42021-08-03 09:39:42 +01001467#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1468 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001469#endif
1470
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001471 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001475
1476 /* Reset incoming message parsing */
1477 ssl->in_offt = NULL;
1478 ssl->nb_zero = 0;
1479 ssl->in_msgtype = 0;
1480 ssl->in_msglen = 0;
1481 ssl->in_hslen = 0;
1482 ssl->keep_current_message = 0;
1483 ssl->transform_in = NULL;
1484
1485#if defined(MBEDTLS_SSL_PROTO_DTLS)
1486 ssl->next_record_offset = 0;
1487 ssl->in_epoch = 0;
1488#endif
1489
1490 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001492 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001494 }
1495
Ronald Cronad8c17b2022-06-10 17:18:09 +02001496 ssl->send_alert = 0;
1497
Hanno Beckerb0302c42021-08-03 09:39:42 +01001498 /* Reset outgoing message writing */
1499 ssl->out_msgtype = 0;
1500 ssl->out_msglen = 0;
1501 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 memset(ssl->out_buf, 0, out_buf_len);
1503 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001504 ssl->transform_out = NULL;
1505
1506#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001508#endif
1509
XiaokangQian2b01dc32022-01-21 02:53:13 +00001510#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 if (ssl->transform) {
1512 mbedtls_ssl_transform_free(ssl->transform);
1513 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001514 ssl->transform = NULL;
1515 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001516#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1517
XiaokangQian2b01dc32022-01-21 02:53:13 +00001518#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 mbedtls_ssl_transform_free(ssl->transform_application);
1520 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521 ssl->transform_application = NULL;
1522
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001524#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1526 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001528#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1531 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->handshake->transform_handshake = NULL;
1533 }
1534
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001536}
1537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001539{
1540 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1541
1542 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001545
1546 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#if defined(MBEDTLS_SSL_RENEGOTIATION)
1548 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001549 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001550
1551 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1553 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001554#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001556
Hanno Beckerb0302c42021-08-03 09:39:42 +01001557 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001558 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 if (ssl->session) {
1560 mbedtls_ssl_session_free(ssl->session);
1561 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001562 ssl->session = NULL;
1563 }
1564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001566 ssl->alpn_chosen = NULL;
1567#endif
1568
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001569#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001570 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001571#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 if (free_cli_id) {
1575 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001576 ssl->cli_id = NULL;
1577 ssl->cli_id_len = 0;
1578 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001579#endif
1580
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 if ((ret = ssl_handshake_init(ssl)) != 0) {
1582 return ret;
1583 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001586}
1587
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001588/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001589 * Reset an initialized and used SSL context for re-use while retaining
1590 * all application-set variables, function pointers and data.
1591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001592int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001593{
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001595}
1596
1597/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 * SSL set accessors
1599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001600void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001601{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001602 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001603}
1604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001606{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001607 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001608}
1609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001610#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001614}
1615#endif
1616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001618{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001619 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1625 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001626{
1627 ssl->disable_datagram_packing = !allow_packing;
1628}
1629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1631 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001632{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001633 conf->hs_timeout_min = min;
1634 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001635}
1636#endif
1637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001639{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001640 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001641}
1642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001644void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1645 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1646 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001647{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001648 conf->f_vrfy = f_vrfy;
1649 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001650}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1654 int (*f_rng)(void *, unsigned char *, size_t),
1655 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001656{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001657 conf->f_rng = f_rng;
1658 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001659}
1660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1662 void (*f_dbg)(void *, int, const char *, int, const char *),
1663 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001664{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001665 conf->f_dbg = f_dbg;
1666 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001667}
1668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1670 void *p_bio,
1671 mbedtls_ssl_send_t *f_send,
1672 mbedtls_ssl_recv_t *f_recv,
1673 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001674{
1675 ssl->p_bio = p_bio;
1676 ssl->f_send = f_send;
1677 ssl->f_recv = f_recv;
1678 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001679}
1680
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001682void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001683{
1684 ssl->mtu = mtu;
1685}
1686#endif
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001689{
1690 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001691}
1692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1694 void *p_timer,
1695 mbedtls_ssl_set_timer_t *f_set_timer,
1696 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001697{
1698 ssl->p_timer = p_timer;
1699 ssl->f_set_timer = f_set_timer;
1700 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001701
1702 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001704}
1705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001707void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1708 void *p_cache,
1709 mbedtls_ssl_cache_get_t *f_get_cache,
1710 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001711{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001712 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001714 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001715}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001720{
Janos Follath865b3eb2019-12-16 11:46:15 +00001721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001722
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001724 session == NULL ||
1725 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001728 }
1729
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (ssl->handshake->resume == 1) {
1731 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1732 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001733
Jerry Yu21092062022-10-10 21:21:31 +08001734#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001736 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001740 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1742 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1743 session->ciphersuite));
1744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001745 }
Jerry Yu40afab62022-10-08 10:42:13 +08001746 }
Jerry Yu21092062022-10-10 21:21:31 +08001747#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1750 session)) != 0) {
1751 return ret;
1752 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001753
Paul Bakker0a597072012-09-25 21:55:46 +00001754 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001757}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1761 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001762{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001763 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001764}
1765
Ronald Cron6f135e12021-12-08 16:57:54 +01001766#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001767void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1768 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001769{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001770 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001771}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001772
1773#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001774void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1775 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001776{
1777 conf->early_data_enabled = early_data_enabled;
1778}
Jerry Yucc4e0072022-11-22 17:22:22 +08001779
1780#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001781void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001783{
Jerry Yu39da9852022-12-06 16:58:36 +08001784 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001785}
1786#endif /* MBEDTLS_SSL_SRV_C */
1787
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001788#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1793 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001794{
1795 conf->cert_profile = profile;
1796}
1797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001799{
1800 mbedtls_ssl_key_cert *cur = key_cert, *next;
1801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001803 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001805 cur = next;
1806 }
1807}
1808
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001809/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1812 mbedtls_x509_crt *cert,
1813 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001814{
niisato8ee24222018-06-25 19:05:48 +09001815 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001820 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001822 }
1823
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1825 if (new_cert == NULL) {
1826 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1827 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001828
niisato8ee24222018-06-25 19:05:48 +09001829 new_cert->cert = cert;
1830 new_cert->key = key;
1831 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001832
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001835 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001837 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001839 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 }
niisato8ee24222018-06-25 19:05:48 +09001841 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001842 }
1843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001845}
1846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850{
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852}
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001855 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001857{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001858 conf->ca_chain = ca_chain;
1859 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001860
1861#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1862 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1863 * cannot be used together. */
1864 conf->f_ca_cb = NULL;
1865 conf->p_ca_cb = NULL;
1866#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001867}
Hanno Becker5adaad92019-03-27 16:54:37 +00001868
1869#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001870void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1871 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1872 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001873{
1874 conf->f_ca_cb = f_ca_cb;
1875 conf->p_ca_cb = p_ca_cb;
1876
1877 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1878 * cannot be used together. */
1879 conf->ca_chain = NULL;
1880 conf->ca_crl = NULL;
1881}
1882#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001884
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001885#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001886const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1887 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001888{
1889 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001891}
1892
Gilles Peskine449bd832023-01-11 14:50:10 +01001893int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1894 mbedtls_x509_crt *own_cert,
1895 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896{
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1898 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001899}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001900
Gilles Peskine449bd832023-01-11 14:50:10 +01001901void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1902 mbedtls_x509_crt *ca_chain,
1903 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001904{
1905 ssl->handshake->sni_ca_chain = ca_chain;
1906 ssl->handshake->sni_ca_crl = ca_crl;
1907}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001908
Glenn Strauss999ef702022-03-11 01:37:23 -05001909#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001910void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1911 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001912{
1913 ssl->handshake->dn_hints = crt;
1914}
1915#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1918 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919{
1920 ssl->handshake->sni_authmode = authmode;
1921}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001922#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1923
Hanno Becker8927c832019-04-03 12:52:50 +01001924#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001925void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1926 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1927 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001928{
1929 ssl->f_vrfy = f_vrfy;
1930 ssl->p_vrfy = p_vrfy;
1931}
1932#endif
1933
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001934#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001935
Valerio Setti016f6822022-12-09 14:17:50 +01001936#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001937static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1938static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1939
Valerio Setti016f6822022-12-09 14:17:50 +01001940static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 mbedtls_ssl_context *ssl,
1942 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001943{
1944 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001945 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001946 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001947 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001948 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001949 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1951 psa_pake_cs_set_primitive(&cipher_suite,
1952 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1953 PSA_ECC_FAMILY_SECP_R1,
1954 256));
1955 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1958 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001959 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001963 user = jpake_server_id;
1964 user_len = sizeof(jpake_server_id);
1965 peer = jpake_client_id;
1966 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001968 user = jpake_client_id;
1969 user_len = sizeof(jpake_client_id);
1970 peer = jpake_server_id;
1971 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001973
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001974 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1975 if (status != PSA_SUCCESS) {
1976 return status;
1977 }
1978
1979 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001981 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Valerio Setti016f6822022-12-09 14:17:50 +01001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1985 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001986 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
Valerio Setti016f6822022-12-09 14:17:50 +01001988
1989 ssl->handshake->psa_pake_ctx_is_ok = 1;
1990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001992}
1993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1995 const unsigned char *pw,
1996 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001997{
1998 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1999 psa_status_t status;
2000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 if (ssl->handshake == NULL || ssl->conf == NULL) {
2002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002003 }
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 /* Empty password is not valid */
2006 if ((pw == NULL) || (pw_len == 0)) {
2007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2008 }
2009
2010 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2011 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2012 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2013
2014 status = psa_import_key(&attributes, pw, pw_len,
2015 &ssl->handshake->psa_pake_password);
2016 if (status != PSA_SUCCESS) {
2017 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2018 }
2019
2020 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2021 ssl->handshake->psa_pake_password);
2022 if (status != PSA_SUCCESS) {
2023 psa_destroy_key(ssl->handshake->psa_pake_password);
2024 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2025 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2026 }
2027
2028 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002029}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2032 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002034 psa_status_t status;
2035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (ssl->handshake == NULL || ssl->conf == NULL) {
2037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002038 }
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 if (mbedtls_svc_key_id_is_null(pwd)) {
2041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2042 }
2043
2044 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2045 if (status != PSA_SUCCESS) {
2046 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2047 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2048 }
2049
2050 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002051}
2052#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002053int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2054 const unsigned char *pw,
2055 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002056{
2057 mbedtls_ecjpake_role role;
2058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (ssl->handshake == NULL || ssl->conf == NULL) {
2060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2061 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002062
Valerio Settic689ed82022-12-07 14:40:38 +01002063 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if ((pw == NULL) || (pw_len == 0)) {
2065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2066 }
Valerio Settic689ed82022-12-07 14:40:38 +01002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002069 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002071 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2075 role,
2076 MBEDTLS_MD_SHA256,
2077 MBEDTLS_ECP_DP_SECP256R1,
2078 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002079}
Valerio Setti02c25b52022-11-15 14:08:42 +01002080#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002081#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082
Ronald Cron73fe8df2022-10-05 14:31:43 +02002083#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002084int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002085{
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 if (conf->psk_identity == NULL ||
2087 conf->psk_identity_len == 0) {
2088 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002089 }
2090
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002091#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2093 return 1;
2094 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk != NULL && conf->psk_len != 0) {
2098 return 1;
2099 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102}
2103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002105{
2106 /* Remove reference to existing PSK, if any. */
2107#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002109 /* The maintenance of the PSK key slot is the
2110 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002111 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002113#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002115 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116 conf->psk = NULL;
2117 conf->psk_len = 0;
2118 }
2119
2120 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (conf->psk_identity != NULL) {
2122 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 conf->psk_identity = NULL;
2124 conf->psk_identity_len = 0;
2125 }
2126}
2127
Hanno Becker7390c712018-11-15 13:33:04 +00002128/* This function assumes that PSK identity in the SSL config is unset.
2129 * It checks that the provided identity is well-formed and attempts
2130 * to make a copy of it in the SSL config.
2131 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002132MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002133static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2134 unsigned char const *psk_identity,
2135 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002136{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002137 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002139 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 (psk_identity_len >> 16) != 0 ||
2141 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002143 }
2144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2146 if (conf->psk_identity == NULL) {
2147 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2148 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002149
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002150 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002154}
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2157 const unsigned char *psk, size_t psk_len,
2158 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002159{
Janos Follath865b3eb2019-12-16 11:46:15 +00002160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002161
2162 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2164 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2165 }
Hanno Becker7390c712018-11-15 13:33:04 +00002166
2167 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (psk == NULL) {
2169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2170 }
2171 if (psk_len == 0) {
2172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2173 }
2174 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2176 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2179 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2180 }
Hanno Becker7390c712018-11-15 13:33:04 +00002181 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002183
2184 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2186 if (ret != 0) {
2187 ssl_conf_remove_psk(conf);
2188 }
Hanno Becker7390c712018-11-15 13:33:04 +00002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002191}
2192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002194{
2195#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002197 /* The maintenance of the external PSK key slot is the
2198 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (ssl->handshake->psk_opaque_is_internal) {
2200 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002201 ssl->handshake->psk_opaque_is_internal = 0;
2202 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002203 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002204 }
Neil Armstronge952a302022-05-03 10:22:14 +02002205#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002207 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002209 ssl->handshake->psk_len = 0;
2210 }
Neil Armstronge952a302022-05-03 10:22:14 +02002211#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002212}
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2215 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002216{
Neil Armstrong501c9322022-05-03 09:35:09 +02002217#if defined(MBEDTLS_USE_PSA_CRYPTO)
2218 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002220 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002221 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
2223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 if (psk == NULL || ssl->handshake == NULL) {
2225 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2226 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2229 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2230 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002233
Neil Armstrong501c9322022-05-03 09:35:09 +02002234#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002235#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2237 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2238 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2239 } else {
2240 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2241 }
2242 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002243 }
2244#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002245
Jerry Yu568ec252022-07-22 21:27:34 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2248 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2249 psa_set_key_usage_flags(&key_attributes,
2250 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002251 }
2252#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 psa_set_key_algorithm(&key_attributes, alg);
2255 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2258 if (status != PSA_SUCCESS) {
2259 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2260 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002261
2262 /* Allow calling psa_destroy_key() on psk remove */
2263 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002265#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2267 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2268 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002269
2270 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002274#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002275}
2276
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002277#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002278int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2279 mbedtls_svc_key_id_t psk,
2280 const unsigned char *psk_identity,
2281 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002282{
Janos Follath865b3eb2019-12-16 11:46:15 +00002283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002284
2285 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2287 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2288 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002289
Hanno Becker7390c712018-11-15 13:33:04 +00002290 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (mbedtls_svc_key_id_is_null(psk)) {
2292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2293 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002294 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002295
2296 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2298 psk_identity_len);
2299 if (ret != 0) {
2300 ssl_conf_remove_psk(conf);
2301 }
Hanno Becker7390c712018-11-15 13:33:04 +00002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002304}
2305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2307 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002308{
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 if ((mbedtls_svc_key_id_is_null(psk)) ||
2310 (ssl->handshake == NULL)) {
2311 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2312 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002315 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002317}
2318#endif /* MBEDTLS_USE_PSA_CRYPTO */
2319
Jerry Yu8897c072022-08-12 13:56:53 +08002320#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002321void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2322 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2323 size_t),
2324 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002325{
2326 conf->f_psk = f_psk;
2327 conf->p_psk = p_psk;
2328}
Jerry Yu8897c072022-08-12 13:56:53 +08002329#endif /* MBEDTLS_SSL_SRV_C */
2330
Ronald Cron73fe8df2022-10-05 14:31:43 +02002331#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002332
2333#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002334static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002337#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 if (alg == PSA_ALG_CBC_NO_PADDING) {
2339 return MBEDTLS_SSL_MODE_CBC;
2340 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002341#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if (PSA_ALG_IS_AEAD(alg)) {
2343 return MBEDTLS_SSL_MODE_AEAD;
2344 }
2345 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002346}
2347
2348#else /* MBEDTLS_USE_PSA_CRYPTO */
2349
2350static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002352{
2353#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (mode == MBEDTLS_MODE_CBC) {
2355 return MBEDTLS_SSL_MODE_CBC;
2356 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002357#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2358
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002359#if defined(MBEDTLS_GCM_C) || \
2360 defined(MBEDTLS_CCM_C) || \
2361 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002363 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 mode == MBEDTLS_MODE_CHACHAPOLY) {
2365 return MBEDTLS_SSL_MODE_AEAD;
2366 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370}
Gilles Peskine301711e2022-04-26 16:57:05 +02002371#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372
Gilles Peskinee108d982022-04-26 16:50:40 +02002373static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2374 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002376{
2377#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2379 base_mode == MBEDTLS_SSL_MODE_CBC) {
2380 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002381 }
2382#else
2383 (void) encrypt_then_mac;
2384#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002386}
2387
Neil Armstrongab555e02022-04-04 11:07:59 +02002388mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002390{
Gilles Peskinee108d982022-04-26 16:50:40 +02002391 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002392#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002394#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002396#endif
2397 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002398
Gilles Peskinee108d982022-04-26 16:50:40 +02002399 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002400#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002401 encrypt_then_mac = transform->encrypt_then_mac;
2402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404}
2405
Neil Armstrongab555e02022-04-04 11:07:59 +02002406mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002407#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002409#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002411{
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2413
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002414#if defined(MBEDTLS_USE_PSA_CRYPTO)
2415 psa_status_t status;
2416 psa_algorithm_t alg;
2417 psa_key_type_t type;
2418 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002419 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2420 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 if (status == PSA_SUCCESS) {
2422 base_mode = mbedtls_ssl_get_base_mode(alg);
2423 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424#else
2425 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002426 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002428 base_mode =
2429 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002431 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002432#endif /* MBEDTLS_USE_PSA_CRYPTO */
2433
Gilles Peskinee108d982022-04-26 16:50:40 +02002434#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2435 int encrypt_then_mac = 0;
2436#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438}
2439
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002440#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002441
2442#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002443/* Serialization of TLS 1.3 sessions:
2444 *
2445 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002446 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002447 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002448 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002449 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002450 * } ClientOnlyData;
2451 *
2452 * struct {
2453 * uint8 endpoint;
2454 * uint8 ciphersuite[2];
2455 * uint32 ticket_age_add;
2456 * uint8 ticket_flags;
2457 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002458 * uint32 max_early_data_size;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002459 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002460 * select ( endpoint ) {
2461 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002462 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002463 * };
2464 * } serialized_session_tls13;
2465 *
2466 */
2467#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002468MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002469static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2470 unsigned char *buf,
2471 size_t buf_len,
2472 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002473{
2474 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002475#if defined(MBEDTLS_SSL_CLI_C) && \
2476 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 size_t hostname_len = (session->hostname == NULL) ?
2478 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002479#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002480 size_t needed = 1 /* endpoint */
2481 + 2 /* ciphersuite */
2482 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002483 + 1 /* ticket_flags */
2484 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002485 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2488 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2489 }
Jerry Yu34191072022-08-18 10:32:09 +08002490 needed += session->resumption_key_len; /* resumption_key */
2491
Jerry Yu02e3a072022-12-12 15:13:20 +08002492#if defined(MBEDTLS_SSL_EARLY_DATA)
2493 needed += 4; /* max_early_data_size */
2494#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002495#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002496 needed += 2; /* record_size_limit */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002497#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002498
Jerry Yu438ddd82022-07-07 06:55:50 +00002499#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002500 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002501#endif
2502
2503#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002505#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002506 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002508#endif
2509
Jerry Yu438ddd82022-07-07 06:55:50 +00002510 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002511 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002512
2513 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (session->ticket_len > SIZE_MAX - needed) {
2515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2516 }
Jerry Yu34191072022-08-18 10:32:09 +08002517
Jerry Yue28d9742022-08-18 15:44:03 +08002518 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002519 }
2520#endif /* MBEDTLS_SSL_CLI_C */
2521
Jerry Yue36fdd62022-08-17 21:31:36 +08002522 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (needed > buf_len) {
2524 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2525 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002526
2527 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2529 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002530 p[7] = session->ticket_flags;
2531
2532 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002533 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002534 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002536 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002537
Jerry Yu02e3a072022-12-12 15:13:20 +08002538#if defined(MBEDTLS_SSL_EARLY_DATA)
2539 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2540 p += 4;
2541#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002542#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2543 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2544 p += 2;
2545#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002546
Jerry Yu438ddd82022-07-07 06:55:50 +00002547#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002549 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002550 p += 8;
2551 }
2552#endif /* MBEDTLS_HAVE_TIME */
2553
2554#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002558 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002560 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002562 p += hostname_len;
2563 }
2564#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2565
Jerry Yu438ddd82022-07-07 06:55:50 +00002566#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002567 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002568 p += 8;
2569#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += 4;
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 if (session->ticket != NULL && session->ticket_len > 0) {
2577 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002578 p += session->ticket_len;
2579 }
2580 }
2581#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002583}
2584
2585MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002586static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2587 const unsigned char *buf,
2588 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002589{
2590 const unsigned char *p = buf;
2591 const unsigned char *end = buf + len;
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (end - p < 9) {
2594 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2595 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002596 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2598 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 session->ticket_flags = p[7];
2600
2601 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002602 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002603 p += 9;
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (end - p < session->resumption_key_len) {
2606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2607 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2611 }
2612 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002613 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002614
Jerry Yu02e3a072022-12-12 15:13:20 +08002615#if defined(MBEDTLS_SSL_EARLY_DATA)
2616 if (end - p < 4) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
2619 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2620 p += 4;
2621#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002622#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2623 if (end - p < 2) {
2624 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2625 }
2626 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
2627 p += 2;
2628#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002629
Jerry Yu438ddd82022-07-07 06:55:50 +00002630#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2632 if (end - p < 8) {
2633 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2634 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002635 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002636 p += 8;
2637 }
2638#endif /* MBEDTLS_HAVE_TIME */
2639
2640#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002642#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002643 size_t hostname_len;
2644 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (end - p < 2) {
2646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2647 }
2648 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002649 p += 2;
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < (long int) hostname_len) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 if (hostname_len > 0) {
2655 session->hostname = mbedtls_calloc(1, hostname_len);
2656 if (session->hostname == NULL) {
2657 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2658 }
2659 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002660 p += hostname_len;
2661 }
Yanray Wangfd256542023-11-22 10:32:03 +08002662#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002663
Jerry Yu438ddd82022-07-07 06:55:50 +00002664#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (end - p < 8) {
2666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2667 }
Jerry Yu342a5552023-11-10 14:23:39 +08002668 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002669 p += 8;
2670#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 if (end - p < 4) {
2672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2673 }
2674 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002675 p += 4;
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 if (end - p < 2) {
2678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2679 }
2680 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002681 p += 2;
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (end - p < (long int) session->ticket_len) {
2684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2685 }
2686 if (session->ticket_len > 0) {
2687 session->ticket = mbedtls_calloc(1, session->ticket_len);
2688 if (session->ticket == NULL) {
2689 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2690 }
2691 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002692 p += session->ticket_len;
2693 }
2694 }
2695#endif /* MBEDTLS_SSL_CLI_C */
2696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002698
2699}
2700#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002701MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002702static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2703 unsigned char *buf,
2704 size_t buf_len,
2705 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002706{
2707 ((void) session);
2708 ((void) buf);
2709 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002710 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002712}
Jerry Yu438ddd82022-07-07 06:55:50 +00002713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2715 unsigned char *buf,
2716 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002717{
2718 ((void) session);
2719 ((void) buf);
2720 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002722}
2723#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002724#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2727 size_t taglen,
2728 psa_algorithm_t *alg,
2729 psa_key_type_t *key_type,
2730 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002731{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002732#if !defined(MBEDTLS_SSL_HAVE_CCM)
2733 (void) taglen;
2734#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002736#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002737 case MBEDTLS_CIPHER_AES_128_CBC:
2738 *alg = PSA_ALG_CBC_NO_PADDING;
2739 *key_type = PSA_KEY_TYPE_AES;
2740 *key_size = 128;
2741 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002742#endif
2743#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002744 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002746 *key_type = PSA_KEY_TYPE_AES;
2747 *key_size = 128;
2748 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002749#endif
2750#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 case MBEDTLS_CIPHER_AES_128_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 128;
2755 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002756#endif
2757#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002758 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002760 *key_type = PSA_KEY_TYPE_AES;
2761 *key_size = 192;
2762 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002763#endif
2764#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002765 case MBEDTLS_CIPHER_AES_192_GCM:
2766 *alg = PSA_ALG_GCM;
2767 *key_type = PSA_KEY_TYPE_AES;
2768 *key_size = 192;
2769 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002770#endif
2771#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002772 case MBEDTLS_CIPHER_AES_256_CBC:
2773 *alg = PSA_ALG_CBC_NO_PADDING;
2774 *key_type = PSA_KEY_TYPE_AES;
2775 *key_size = 256;
2776 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002777#endif
2778#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002779 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002781 *key_type = PSA_KEY_TYPE_AES;
2782 *key_size = 256;
2783 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002784#endif
2785#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002786 case MBEDTLS_CIPHER_AES_256_GCM:
2787 *alg = PSA_ALG_GCM;
2788 *key_type = PSA_KEY_TYPE_AES;
2789 *key_size = 256;
2790 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002791#endif
2792#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002793 case MBEDTLS_CIPHER_ARIA_128_CBC:
2794 *alg = PSA_ALG_CBC_NO_PADDING;
2795 *key_type = PSA_KEY_TYPE_ARIA;
2796 *key_size = 128;
2797 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002798#endif
2799#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002802 *key_type = PSA_KEY_TYPE_ARIA;
2803 *key_size = 128;
2804 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002805#endif
2806#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002807 case MBEDTLS_CIPHER_ARIA_128_GCM:
2808 *alg = PSA_ALG_GCM;
2809 *key_type = PSA_KEY_TYPE_ARIA;
2810 *key_size = 128;
2811 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002812#endif
2813#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002814 case MBEDTLS_CIPHER_ARIA_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_ARIA;
2817 *key_size = 192;
2818 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002819#endif
2820#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002821 case MBEDTLS_CIPHER_ARIA_192_GCM:
2822 *alg = PSA_ALG_GCM;
2823 *key_type = PSA_KEY_TYPE_ARIA;
2824 *key_size = 192;
2825 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002826#endif
2827#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 case MBEDTLS_CIPHER_ARIA_256_CBC:
2829 *alg = PSA_ALG_CBC_NO_PADDING;
2830 *key_type = PSA_KEY_TYPE_ARIA;
2831 *key_size = 256;
2832 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002833#endif
2834#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002835 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002837 *key_type = PSA_KEY_TYPE_ARIA;
2838 *key_size = 256;
2839 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002840#endif
2841#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002842 case MBEDTLS_CIPHER_ARIA_256_GCM:
2843 *alg = PSA_ALG_GCM;
2844 *key_type = PSA_KEY_TYPE_ARIA;
2845 *key_size = 256;
2846 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002847#endif
2848#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002849 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2850 *alg = PSA_ALG_CBC_NO_PADDING;
2851 *key_type = PSA_KEY_TYPE_CAMELLIA;
2852 *key_size = 128;
2853 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002854#endif
2855#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002856 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002858 *key_type = PSA_KEY_TYPE_CAMELLIA;
2859 *key_size = 128;
2860 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002861#endif
2862#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002863 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2864 *alg = PSA_ALG_GCM;
2865 *key_type = PSA_KEY_TYPE_CAMELLIA;
2866 *key_size = 128;
2867 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002868#endif
2869#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002870 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002872 *key_type = PSA_KEY_TYPE_CAMELLIA;
2873 *key_size = 192;
2874 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002875#endif
2876#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002877 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2878 *alg = PSA_ALG_GCM;
2879 *key_type = PSA_KEY_TYPE_CAMELLIA;
2880 *key_size = 192;
2881 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002882#endif
2883#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002884 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2885 *alg = PSA_ALG_CBC_NO_PADDING;
2886 *key_type = PSA_KEY_TYPE_CAMELLIA;
2887 *key_size = 256;
2888 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002889#endif
2890#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002891 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002893 *key_type = PSA_KEY_TYPE_CAMELLIA;
2894 *key_size = 256;
2895 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002896#endif
2897#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002898 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2899 *alg = PSA_ALG_GCM;
2900 *key_type = PSA_KEY_TYPE_CAMELLIA;
2901 *key_size = 256;
2902 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002903#endif
2904#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002905 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2906 *alg = PSA_ALG_CHACHA20_POLY1305;
2907 *key_type = PSA_KEY_TYPE_CHACHA20;
2908 *key_size = 256;
2909 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002910#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002911 case MBEDTLS_CIPHER_NULL:
2912 *alg = MBEDTLS_SSL_NULL_CIPHER;
2913 *key_type = 0;
2914 *key_size = 0;
2915 break;
2916 default:
2917 return PSA_ERROR_NOT_SUPPORTED;
2918 }
2919
2920 return PSA_SUCCESS;
2921}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002922#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002923
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002924#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002925int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2926 const unsigned char *dhm_P, size_t P_len,
2927 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002928{
Janos Follath865b3eb2019-12-16 11:46:15 +00002929 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 mbedtls_mpi_free(&conf->dhm_P);
2932 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2935 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2936 mbedtls_mpi_free(&conf->dhm_P);
2937 mbedtls_mpi_free(&conf->dhm_G);
2938 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002939 }
2940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002942}
Paul Bakker5121ce52009-01-03 21:22:43 +00002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002945{
Janos Follath865b3eb2019-12-16 11:46:15 +00002946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 mbedtls_mpi_free(&conf->dhm_P);
2949 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2952 &conf->dhm_P)) != 0 ||
2953 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2954 &conf->dhm_G)) != 0) {
2955 mbedtls_mpi_free(&conf->dhm_P);
2956 mbedtls_mpi_free(&conf->dhm_G);
2957 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002958 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002961}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002962#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002963
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002964#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2965/*
2966 * Set the minimum length for Diffie-Hellman parameters
2967 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002968void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2969 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002970{
2971 conf->dhm_min_bitlen = bitlen;
2972}
2973#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2974
Ronald Crone68ab4f2022-10-05 12:46:29 +02002975#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002976#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002977/*
2978 * Set allowed/preferred hashes for handshake signatures
2979 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002980void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2981 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002982{
2983 conf->sig_hashes = hashes;
2984}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002985#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002986
Jerry Yuf017ee42022-01-12 15:49:48 +08002987/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002988void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2989 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002990{
Jerry Yuf017ee42022-01-12 15:49:48 +08002991#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2992 conf->sig_hashes = NULL;
2993#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2994 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002995}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002996#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002997
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002998#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002999#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003000/*
3001 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003002 *
3003 * mbedtls_ssl_setup() takes the provided list
3004 * and translates it to a list of IANA TLS group identifiers,
3005 * stored in ssl->handshake->group_list.
3006 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003008void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3009 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003010{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003011 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003012 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003013}
Brett Warrene0edc842021-08-17 09:53:13 +01003014#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003015#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003016
Brett Warrene0edc842021-08-17 09:53:13 +01003017/*
3018 * Set the allowed groups
3019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003020void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3021 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003022{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003023#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003024 conf->curve_list = NULL;
3025#endif
3026 conf->group_list = group_list;
3027}
3028
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003029#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003030int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003031{
Hanno Becker947194e2017-04-07 13:25:49 +01003032 /* Initialize to suppress unnecessary compiler warning */
3033 size_t hostname_len = 0;
3034
3035 /* Check if new hostname is valid before
3036 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 if (hostname != NULL) {
3038 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3042 }
Hanno Becker947194e2017-04-07 13:25:49 +01003043 }
3044
3045 /* Now it's clear that we will overwrite the old hostname,
3046 * so we can free it safely */
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003049 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003050 }
3051
3052 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003055 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 } else {
3057 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3058 if (ssl->hostname == NULL) {
3059 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3060 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003063
Hanno Becker947194e2017-04-07 13:25:49 +01003064 ssl->hostname[hostname_len] = '\0';
3065 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003068}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003069#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003070
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003071#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003072void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3073 int (*f_sni)(void *, mbedtls_ssl_context *,
3074 const unsigned char *, size_t),
3075 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003076{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003077 conf->f_sni = f_sni;
3078 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003079}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003083int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003084{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003085 size_t cur_len, tot_len;
3086 const char **p;
3087
3088 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003089 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3090 * MUST NOT be truncated."
3091 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003092 */
3093 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 for (p = protos; *p != NULL; p++) {
3095 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003096 tot_len += cur_len;
3097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if ((cur_len == 0) ||
3099 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3100 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3102 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003103 }
3104
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003105 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003111{
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003113}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003115
Johan Pascalb62bb512015-12-03 21:56:45 +01003116#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003117void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3118 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003119{
3120 conf->dtls_srtp_mki_support = support_mki_value;
3121}
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3124 unsigned char *mki_value,
3125 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003126{
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003129 }
Ron Eldor591f1622018-01-22 12:30:04 +02003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3132 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003133 }
Ron Eldor591f1622018-01-22 12:30:04 +02003134
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003136 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003138}
3139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3141 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003142{
Johan Pascal253d0262020-09-22 13:04:45 +02003143 const mbedtls_ssl_srtp_profile *p;
3144 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003145
Johan Pascal253d0262020-09-22 13:04:45 +02003146 /* check the profiles list: all entry must be valid,
3147 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3149 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3150 p++) {
3151 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003152 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003154 /* unsupported value, stop parsing and set the size to an error value */
3155 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003156 }
3157 }
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3160 conf->dtls_srtp_profile_list = NULL;
3161 conf->dtls_srtp_profile_list_len = 0;
3162 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003163 }
3164
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003165 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003166 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003169}
3170
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3172 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003173{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003174 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3175 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003177 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003179 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3181 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003182 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003183}
Johan Pascalb62bb512015-12-03 21:56:45 +01003184#endif /* MBEDTLS_SSL_DTLS_SRTP */
3185
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303186#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003187void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003188{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003189 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003190}
3191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003193{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003194 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003195}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303196#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003197
Janos Follath088ce432017-04-10 12:42:31 +01003198#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003199void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3200 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003201{
3202 conf->cert_req_ca_list = cert_req_ca_list;
3203}
3204#endif
3205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003207void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003209 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003210}
3211#endif
3212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003214void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003216 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003217}
3218#endif
3219
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003221int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003222{
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3224 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3225 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003226 }
3227
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003228 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003231}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003235{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003236 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003237}
3238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003240void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003242 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003243}
3244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003246{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003247 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003248}
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3251 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003252{
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003254}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003258#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003259void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003260{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003261 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003262}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003263#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003264
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003265#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003266
Jerry Yud0766ec2022-09-22 10:46:57 +08003267#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003268void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3269 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003270{
Jerry Yud0766ec2022-09-22 10:46:57 +08003271 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003272}
3273#endif
3274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3276 mbedtls_ssl_ticket_write_t *f_ticket_write,
3277 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3278 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003279{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003280 conf->f_ticket_write = f_ticket_write;
3281 conf->f_ticket_parse = f_ticket_parse;
3282 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003283}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003284#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3288 mbedtls_ssl_export_keys_t *f_export_keys,
3289 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003290{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003291 ssl->f_export_keys = f_export_keys;
3292 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003293}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003294
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003295#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003296void mbedtls_ssl_conf_async_private_cb(
3297 mbedtls_ssl_config *conf,
3298 mbedtls_ssl_async_sign_t *f_async_sign,
3299 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3300 mbedtls_ssl_async_resume_t *f_async_resume,
3301 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003303{
3304 conf->f_async_sign_start = f_async_sign;
3305 conf->f_async_decrypt_start = f_async_decrypt;
3306 conf->f_async_resume = f_async_resume;
3307 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003308 conf->p_async_config_data = async_config_data;
3309}
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003312{
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003314}
3315
Gilles Peskine449bd832023-01-11 14:50:10 +01003316void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003317{
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 if (ssl->handshake == NULL) {
3319 return NULL;
3320 } else {
3321 return ssl->handshake->user_async_ctx;
3322 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003323}
3324
Gilles Peskine449bd832023-01-11 14:50:10 +01003325void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3326 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003327{
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003329 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003331}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003332#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003333
Paul Bakker5121ce52009-01-03 21:22:43 +00003334/*
3335 * SSL get accessors
3336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003338{
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl->session != NULL) {
3340 return ssl->session->verify_result;
3341 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003342
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 if (ssl->session_negotiate != NULL) {
3344 return ssl->session_negotiate->verify_result;
3345 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003346
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003348}
3349
Gilles Peskine449bd832023-01-11 14:50:10 +01003350int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003351{
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 if (ssl == NULL || ssl->session == NULL) {
3353 return 0;
3354 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003355
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003357}
3358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003360{
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (ssl == NULL || ssl->session == NULL) {
3362 return NULL;
3363 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003366}
3367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003369{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3372 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003373 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003375 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003377 }
3378 }
3379#endif
3380
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003382 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003384 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003386 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003388 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003389}
3390
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003391#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3392
3393size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3394{
3395 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3396 size_t record_size_limit = max_len;
3397
3398 if (ssl->session != NULL &&
3399 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3400 ssl->session->record_size_limit < max_len) {
3401 record_size_limit = ssl->session->record_size_limit;
3402 }
3403
3404 // TODO: this is currently untested
3405 /* During a handshake, use the value being negotiated */
3406 if (ssl->session_negotiate != NULL &&
3407 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3408 ssl->session_negotiate->record_size_limit < max_len) {
3409 record_size_limit = ssl->session_negotiate->record_size_limit;
3410 }
3411
3412 return record_size_limit;
3413}
3414#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3415
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003416#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003417size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003418{
David Horstmann95d516f2021-05-04 18:36:56 +01003419 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003420 size_t read_mfl;
3421
Jerry Yuddda0502022-12-01 19:43:12 +08003422#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003423 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3425 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3426 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003427 }
Jerry Yuddda0502022-12-01 19:43:12 +08003428#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003429
3430 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (ssl->session_out != NULL) {
3432 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3433 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003434 max_len = read_mfl;
3435 }
3436 }
3437
Jerry Yuddda0502022-12-01 19:43:12 +08003438 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 if (ssl->session_negotiate != NULL) {
3440 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3441 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003442 max_len = read_mfl;
3443 }
3444 }
3445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003447}
3448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003450{
3451 size_t max_len;
3452
3453 /*
3454 * Assume mfl_code is correct since it was checked when set
3455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003457
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003458 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 if (ssl->session_out != NULL &&
3460 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3461 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003462 }
3463
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003464 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 if (ssl->session_negotiate != NULL &&
3466 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3467 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003468 }
3469
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003471}
3472#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3473
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003474#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003475size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003476{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003477 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3479 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3480 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3481 return 0;
3482 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003483
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3485 return ssl->mtu;
3486 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003487
Gilles Peskine449bd832023-01-11 14:50:10 +01003488 if (ssl->mtu == 0) {
3489 return ssl->handshake->mtu;
3490 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003491
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 return ssl->mtu < ssl->handshake->mtu ?
3493 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003494}
3495#endif /* MBEDTLS_SSL_PROTO_DTLS */
3496
Gilles Peskine449bd832023-01-11 14:50:10 +01003497int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003498{
3499 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3500
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003501#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003502 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003503 !defined(MBEDTLS_SSL_PROTO_DTLS)
3504 (void) ssl;
3505#endif
3506
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003507#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003508 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003509
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003511 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003513#endif
3514
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003515#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3516 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3517
3518 if (max_len > record_size_limit) {
3519 max_len = record_size_limit;
3520 }
3521#endif
3522
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003523 if (ssl->transform_out != NULL &&
3524 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003525 /*
3526 * In TLS 1.3 case, when records are protected, `max_len` as computed
3527 * above is the maximum length of the TLSInnerPlaintext structure that
3528 * along the plaintext payload contains the inner content type (one byte)
3529 * and some zero padding. Given the algorithm used for padding
3530 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3531 * the plaintext payload. Round down to a multiple of
3532 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3533 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003534 */
3535 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3536 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3537 }
3538
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003539#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003540 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3541 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3542 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003543 const size_t overhead = (size_t) ret;
3544
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 if (ret < 0) {
3546 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003547 }
3548
Gilles Peskine449bd832023-01-11 14:50:10 +01003549 if (mtu <= overhead) {
3550 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3551 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3552 }
3553
3554 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003555 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003556 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003557 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003558#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003559
Hanno Becker0defedb2018-08-10 12:35:02 +01003560#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003561 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3562 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003563 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003564#endif
3565
Gilles Peskine449bd832023-01-11 14:50:10 +01003566 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003567}
3568
Gilles Peskine449bd832023-01-11 14:50:10 +01003569int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003570{
3571 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3572
3573#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3574 (void) ssl;
3575#endif
3576
3577#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003578 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003579
Gilles Peskine449bd832023-01-11 14:50:10 +01003580 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003581 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003582 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003583#endif
3584
Gilles Peskine449bd832023-01-11 14:50:10 +01003585 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003586}
3587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003589const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003590{
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (ssl == NULL || ssl->session == NULL) {
3592 return NULL;
3593 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003594
Hanno Beckere6824572019-02-07 13:18:46 +00003595#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003596 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003597#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003598 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003599#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003600}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003604int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3605 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003606{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003607 int ret;
3608
Gilles Peskine449bd832023-01-11 14:50:10 +01003609 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003610 dst == NULL ||
3611 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003614 }
3615
Hanno Beckere810bbc2021-05-14 16:01:05 +01003616 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3617 * idempotent: Each session can only be exported once.
3618 *
3619 * (This is in preparation for TLS 1.3 support where we will
3620 * need the ability to export multiple sessions (aka tickets),
3621 * which will be achieved by calling mbedtls_ssl_get_session()
3622 * multiple times until it fails.)
3623 *
3624 * Check whether we have already exported the current session,
3625 * and fail if so.
3626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003627 if (ssl->session->exported == 1) {
3628 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3629 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003630
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3632 if (ret != 0) {
3633 return ret;
3634 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003635
3636 /* Remember that we've exported the session. */
3637 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003638 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003639}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003641
Paul Bakker5121ce52009-01-03 21:22:43 +00003642/*
Hanno Beckera835da52019-05-16 12:39:07 +01003643 * Define ticket header determining Mbed TLS version
3644 * and structure of the ticket.
3645 */
3646
Hanno Becker94ef3b32019-05-16 12:50:45 +01003647/*
Hanno Becker50b59662019-05-28 14:30:45 +01003648 * Define bitflag determining compile-time settings influencing
3649 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003650 */
3651
Hanno Becker50b59662019-05-28 14:30:45 +01003652#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003653#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003654#else
Hanno Becker3e088662019-05-29 11:10:18 +01003655#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003656#endif /* MBEDTLS_HAVE_TIME */
3657
3658#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003659#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003660#else
Hanno Becker3e088662019-05-29 11:10:18 +01003661#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003662#endif /* MBEDTLS_X509_CRT_PARSE_C */
3663
3664#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003665#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003666#else
Hanno Becker3e088662019-05-29 11:10:18 +01003667#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003668#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3669
3670#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003671#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003672#else
Hanno Becker3e088662019-05-29 11:10:18 +01003673#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003674#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3675
Hanno Becker94ef3b32019-05-16 12:50:45 +01003676#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003677#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003678#else
Hanno Becker3e088662019-05-29 11:10:18 +01003679#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003680#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3681
Hanno Becker94ef3b32019-05-16 12:50:45 +01003682#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3683#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3684#else
3685#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3686#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3687
Hanno Becker3e088662019-05-29 11:10:18 +01003688#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3689#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3690#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3691#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003692#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3693#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003694
Hanno Becker50b59662019-05-28 14:30:45 +01003695#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 ((uint16_t) ( \
3697 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3698 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3699 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3700 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3701 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3702 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3703 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003704
Hanno Beckerf8787072019-05-16 12:41:07 +01003705static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003706 MBEDTLS_VERSION_MAJOR,
3707 MBEDTLS_VERSION_MINOR,
3708 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3710 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003711};
Hanno Beckera835da52019-05-16 12:39:07 +01003712
3713/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003714 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003715 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003716 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003717 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003718 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003719 * opaque mbedtls_version[3]; // library version: major, minor, patch
3720 * opaque session_format[2]; // library-version specific 16-bit field
3721 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003722 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003723 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724 * Note: When updating the format, remember to keep
3725 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003726 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003727 * // In this version, `session_format` determines
3728 * // the setting of those compile-time
3729 * // configuration options which influence
3730 * // the structure of mbedtls_ssl_session.
3731 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003732 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003733 * // - TLS 1.2 (0x0303)
3734 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003735 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003736 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003738 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003739 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003740 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003741 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003742 *
3743 * };
3744 *
3745 * } serialized_session;
3746 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003747 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003748
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003749MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003750static int ssl_session_save(const mbedtls_ssl_session *session,
3751 unsigned char omit_header,
3752 unsigned char *buf,
3753 size_t buf_len,
3754 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003755{
3756 unsigned char *p = buf;
3757 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003758 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003759#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3760 size_t out_len;
3761 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3762#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 if (session == NULL) {
3764 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3765 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003766
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003768 /*
3769 * Add Mbed TLS version identifier
3770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003772
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 if (used <= buf_len) {
3774 memcpy(p, ssl_serialized_session_header,
3775 sizeof(ssl_serialized_session_header));
3776 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003777 }
3778 }
3779
3780 /*
3781 * TLS version identifier
3782 */
3783 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (used <= buf_len) {
3785 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003786 }
3787
3788 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003789 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003790 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003791#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003792 case MBEDTLS_SSL_VERSION_TLS1_2:
3793 used += ssl_tls12_session_save(session, p, remaining_len);
3794 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003795#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3796
Jerry Yu251a12e2022-07-13 15:15:48 +08003797#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 case MBEDTLS_SSL_VERSION_TLS1_3:
3799 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3800 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3801 return ret;
3802 }
3803 used += out_len;
3804 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003805#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3806
Gilles Peskine449bd832023-01-11 14:50:10 +01003807 default:
3808 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003809 }
3810
3811 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 if (used > buf_len) {
3813 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3814 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003815
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003817}
3818
3819/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003820 * Public wrapper for ssl_session_save()
3821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003822int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3823 unsigned char *buf,
3824 size_t buf_len,
3825 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003826{
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003828}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003829
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003830/*
3831 * Deserialize session, see mbedtls_ssl_session_save() for format.
3832 *
3833 * This internal version is wrapped by a public function that cleans up in
3834 * case of error, and has an extra option omit_header.
3835 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003837static int ssl_session_load(mbedtls_ssl_session *session,
3838 unsigned char omit_header,
3839 const unsigned char *buf,
3840 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003841{
3842 const unsigned char *p = buf;
3843 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003844 size_t remaining_len;
3845
3846
Gilles Peskine449bd832023-01-11 14:50:10 +01003847 if (session == NULL) {
3848 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3849 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003850
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003852 /*
3853 * Check Mbed TLS version identifier
3854 */
3855
Gilles Peskine449bd832023-01-11 14:50:10 +01003856 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3857 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003858 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003859
3860 if (memcmp(p, ssl_serialized_session_header,
3861 sizeof(ssl_serialized_session_header)) != 0) {
3862 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3863 }
3864 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003865 }
3866
3867 /*
3868 * TLS version identifier
3869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if (1 > (size_t) (end - p)) {
3871 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3872 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003873 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003874
3875 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003876 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003878#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003879 case MBEDTLS_SSL_VERSION_TLS1_2:
3880 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003881#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3882
Jerry Yu438ddd82022-07-07 06:55:50 +00003883#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 case MBEDTLS_SSL_VERSION_TLS1_3:
3885 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003886#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3887
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 default:
3889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003890 }
3891}
3892
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003893/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003894 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003896int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3897 const unsigned char *buf,
3898 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003899{
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003901
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 if (ret != 0) {
3903 mbedtls_ssl_session_free(session);
3904 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003905
Gilles Peskine449bd832023-01-11 14:50:10 +01003906 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003907}
3908
3909/*
Paul Bakker1961b702013-01-25 14:49:24 +01003910 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003911 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003912MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003913static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003914{
3915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3916
Ronald Cron66dbf912022-02-02 15:33:46 +01003917 /*
3918 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003919 * that were written into the output buffer by the previous handshake step,
3920 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003921 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3922 * We proceed to the next handshake step only when all data from the
3923 * previous one have been sent to the peer, thus we make sure that this is
3924 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3925 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3926 * we have to wait before to go ahead.
3927 * In the case of TLS 1.3, handshake step handlers do not send data to the
3928 * peer. Data are only sent here and through
3929 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003930 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3933 return ret;
3934 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003935
3936#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3938 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3939 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3940 return ret;
3941 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003942 }
3943#endif /* MBEDTLS_SSL_PROTO_DTLS */
3944
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003946}
3947
Gilles Peskine449bd832023-01-11 14:50:10 +01003948int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003949{
Hanno Becker41934dd2021-08-07 19:13:43 +01003950 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003951
Gilles Peskine449bd832023-01-11 14:50:10 +01003952 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003953 ssl->conf == NULL ||
3954 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003957 }
3958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 ret = ssl_prepare_handshake_step(ssl);
3960 if (ret != 0) {
3961 return ret;
3962 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 ret = mbedtls_ssl_handle_pending_alert(ssl);
3965 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003966 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 }
Jerry Yue7047812021-09-13 19:26:39 +08003968
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003969 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3970 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3971 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003973#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3975 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003976 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003979 case MBEDTLS_SSL_HELLO_REQUEST:
3980 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003981 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003982 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003983
Ronald Cron9f0fba32022-02-10 16:45:15 +01003984 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003986 break;
3987
3988 default:
3989#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3991 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3992 } else {
3993 ret = mbedtls_ssl_handshake_client_step(ssl);
3994 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003995#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003997#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003999#endif
4000 }
Jerry Yub9930e72021-08-06 17:11:51 +08004001 }
Ronald Cron6291b232023-03-08 15:51:25 +01004002#endif /* MBEDTLS_SSL_CLI_C */
4003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004004#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004006#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4007 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004009 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 ret = mbedtls_ssl_handshake_server_step(ssl);
4011 }
Ronald Cron6291b232023-03-08 15:51:25 +01004012#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4013 ret = mbedtls_ssl_handshake_server_step(ssl);
4014#else
4015 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004016#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004017 }
4018#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004021 /* handshake_step return error. And it is same
4022 * with alert_reason.
4023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (ssl->send_alert) {
4025 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004026 goto cleanup;
4027 }
4028 }
4029
4030cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004032}
4033
4034/*
4035 * Perform the SSL handshake
4036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004037int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004038{
4039 int ret = 0;
4040
Hanno Beckera817ea42020-10-20 15:20:23 +01004041 /* Sanity checks */
4042
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (ssl == NULL || ssl->conf == NULL) {
4044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4045 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004046
Hanno Beckera817ea42020-10-20 15:20:23 +01004047#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4049 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4050 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4051 "mbedtls_ssl_set_timer_cb() for DTLS"));
4052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004053 }
4054#endif /* MBEDTLS_SSL_PROTO_DTLS */
4055
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004057
Hanno Beckera817ea42020-10-20 15:20:23 +01004058 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4060 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004063 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 }
Paul Bakker1961b702013-01-25 14:49:24 +01004065 }
4066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004070}
4071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004072#if defined(MBEDTLS_SSL_RENEGOTIATION)
4073#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004074/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004075 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004076 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004077MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004078static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004079{
Janos Follath865b3eb2019-12-16 11:46:15 +00004080 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004083
4084 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004085 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4086 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4089 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4090 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004091 }
4092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004094
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004096}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004097#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004098
4099/*
4100 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004101 * - any side: calling mbedtls_ssl_renegotiate(),
4102 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4103 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004104 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004105 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004106 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004108int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004109{
Janos Follath865b3eb2019-12-16 11:46:15 +00004110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if ((ret = ssl_handshake_init(ssl)) != 0) {
4115 return ret;
4116 }
Paul Bakker48916f92012-09-16 19:57:18 +00004117
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004118 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4119 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004120#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4122 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4123 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004124 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004126 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004128 }
4129#endif
4130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4132 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4135 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4136 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004137 }
4138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004140
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004142}
4143
4144/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004145 * Renegotiate current connection on client,
4146 * or request renegotiation on server
4147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004148int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004149{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004150 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (ssl == NULL || ssl->conf == NULL) {
4153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4154 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004156#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004157 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4159 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4161 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004163 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004164
4165 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (ssl->out_left != 0) {
4167 return mbedtls_ssl_flush_output(ssl);
4168 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004171 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004172#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004174#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004175 /*
4176 * On client, either start the renegotiation process or,
4177 * if already in progress, continue the handshake
4178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4180 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004182 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004183
4184 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4185 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4186 return ret;
4187 }
4188 } else {
4189 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4190 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4191 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004192 }
4193 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004194#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004197}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004198#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004201{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004202 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004205 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004207
Valerio Setti6f0441d2023-07-03 12:11:36 +02004208#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004209#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 if (ssl->handshake->group_list_heap_allocated) {
4211 mbedtls_free((void *) handshake->group_list);
4212 }
Brett Warrene0edc842021-08-17 09:53:13 +01004213 handshake->group_list = NULL;
4214#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004215#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004216
Ronald Crone68ab4f2022-10-05 12:46:29 +02004217#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004218#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 if (ssl->handshake->sig_algs_heap_allocated) {
4220 mbedtls_free((void *) handshake->sig_algs);
4221 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004222 handshake->sig_algs = NULL;
4223#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004224#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (ssl->handshake->certificate_request_context) {
4226 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004227 }
4228#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004229#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004230
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004231#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4233 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004234 handshake->async_in_progress = 0;
4235 }
4236#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4237
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004238#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004239#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004241#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004242 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004243#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004244#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004245#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004246#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004248#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004249 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004250#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004251#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004253#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004255#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004256#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004257 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004259#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004260
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004261#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004262#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004264 /*
4265 * Opaque keys are not stored in the handshake's data and it's the user
4266 * responsibility to destroy them. Clear ones, instead, are created by
4267 * the TLS library and should be destroyed at the same level
4268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4270 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004271 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004272 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4273#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004275#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004276#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004278 handshake->ecjpake_cache = NULL;
4279 handshake->ecjpake_cache_len = 0;
4280#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004281#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004282
Valerio Setti7aeec542023-07-05 18:57:21 +02004283#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004284 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004285 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004286 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004288#endif
4289
Ronald Cron73fe8df2022-10-05 14:31:43 +02004290#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004293 /* The maintenance of the external PSK key slot is the
4294 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (ssl->handshake->psk_opaque_is_internal) {
4296 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004297 ssl->handshake->psk_opaque_is_internal = 0;
4298 }
4299 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4300 }
Neil Armstronge952a302022-05-03 10:22:14 +02004301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004303 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004304 }
Neil Armstronge952a302022-05-03 10:22:14 +02004305#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004306#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004308#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4309 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004310 /*
4311 * Free only the linked list wrapper, not the keys themselves
4312 * since the belong to the SNI callback
4313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004315#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004316
Gilles Peskineeccd8882020-03-10 12:19:08 +01004317#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4319 if (handshake->ecrs_peer_cert != NULL) {
4320 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4321 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004322 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004323#endif
4324
Hanno Becker75173122019-02-06 16:18:31 +00004325#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4326 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004328#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4329
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004330#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4332 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004333#endif /* MBEDTLS_SSL_CLI_C &&
4334 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004335
4336#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 mbedtls_ssl_flight_free(handshake->flight);
4338 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004339#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004340
Valerio Settiea59c432023-07-25 11:14:03 +02004341#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004342 if (handshake->xxdh_psa_privkey_is_external == 0) {
4343 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 }
Valerio Settiea59c432023-07-25 11:14:03 +02004345#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004346
Ronald Cron6f135e12021-12-08 16:57:54 +01004347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 mbedtls_ssl_transform_free(handshake->transform_handshake);
4349 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004350#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4352 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004353#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004354#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004355
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004356
4357#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4358 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4359 * processes datagrams and the fact that a datagram is allowed to have
4360 * several records in it, it is possible that the I/O buffers are not
4361 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4363 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004364#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004365
Jerry Yuba9c7272021-10-30 11:54:10 +08004366 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 mbedtls_platform_zeroize(handshake,
4368 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004369}
4370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004372{
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004374 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004377#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004379#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004380
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004381#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004382#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4383 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004385#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004387#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004390}
4391
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004392#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004393
4394#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4395#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4396#else
4397#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4398#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4399
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004400#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004401
4402#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4403#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4404#else
4405#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4406#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4407
4408#if defined(MBEDTLS_SSL_ALPN)
4409#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4410#else
4411#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4412#endif /* MBEDTLS_SSL_ALPN */
4413
4414#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4415#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4416#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4417#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4418
4419#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 ((uint32_t) ( \
4421 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4422 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4423 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4424 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4425 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4426 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4427 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4428 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004429
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004430static unsigned char ssl_serialized_context_header[] = {
4431 MBEDTLS_VERSION_MAJOR,
4432 MBEDTLS_VERSION_MINOR,
4433 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4435 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4436 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4437 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4438 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004439};
4440
Paul Bakker5121ce52009-01-03 21:22:43 +00004441/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004442 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004443 *
4444 * The format of the serialized data is:
4445 * (in the presentation language of TLS, RFC 8446 section 3)
4446 *
4447 * // header
4448 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004449 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004450 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004451 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004452 * Note: When updating the format, remember to keep these
4453 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004454 *
4455 * // session sub-structure
4456 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4457 * // transform sub-structure
4458 * uint8 random[64]; // ServerHello.random+ClientHello.random
4459 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4460 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4461 * // fields from ssl_context
4462 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4463 * uint64 in_window_top; // DTLS: last validated record seq_num
4464 * uint64 in_window; // DTLS: bitmask for replay protection
4465 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4466 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4467 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4468 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4469 *
4470 * Note that many fields of the ssl_context or sub-structures are not
4471 * serialized, as they fall in one of the following categories:
4472 *
4473 * 1. forced value (eg in_left must be 0)
4474 * 2. pointer to dynamically-allocated memory (eg session, transform)
4475 * 3. value can be re-derived from other data (eg session keys from MS)
4476 * 4. value was temporary (eg content of input buffer)
4477 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004479int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4480 unsigned char *buf,
4481 size_t buf_len,
4482 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004483{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004484 unsigned char *p = buf;
4485 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004486 size_t session_len;
4487 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004488
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004489 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004490 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4491 * this function's documentation.
4492 *
4493 * These are due to assumptions/limitations in the implementation. Some of
4494 * them are likely to stay (no handshake in progress) some might go away
4495 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004496 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004497 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4499 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004501 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (ssl->handshake != NULL) {
4503 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4504 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004505 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004506 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 if (ssl->transform == NULL || ssl->session == NULL) {
4508 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4509 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004510 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004511 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (mbedtls_ssl_check_pending(ssl) != 0) {
4513 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004515 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 if (ssl->out_left != 0) {
4517 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4518 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004519 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004520 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4522 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4523 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004524 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004525 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4527 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4528 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004529 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004530 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4532 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4533 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004534 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004535 /* Renegotiation must not be enabled */
4536#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4538 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4539 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004540 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004541#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004542
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004543 /*
4544 * Version and format identifier
4545 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (used <= buf_len) {
4549 memcpy(p, ssl_serialized_context_header,
4550 sizeof(ssl_serialized_context_header));
4551 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004552 }
4553
4554 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004555 * Session (length + data)
4556 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4558 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4559 return ret;
4560 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004561
4562 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (used <= buf_len) {
4564 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004565 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 ret = ssl_session_save(ssl->session, 1,
4568 p, session_len, &session_len);
4569 if (ret != 0) {
4570 return ret;
4571 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004572
4573 p += session_len;
4574 }
4575
4576 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004577 * Transform
4578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 used += sizeof(ssl->transform->randbytes);
4580 if (used <= buf_len) {
4581 memcpy(p, ssl->transform->randbytes,
4582 sizeof(ssl->transform->randbytes));
4583 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004584 }
4585
4586#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004587 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004589 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004591 p += ssl->transform->in_cid_len;
4592
4593 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004595 p += ssl->transform->out_cid_len;
4596 }
4597#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4598
4599 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004600 * Saved fields from top-level ssl_context structure
4601 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004602 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (used <= buf_len) {
4604 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004605 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004606 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004607
4608#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4609 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 if (used <= buf_len) {
4611 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004612 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004615 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004616 }
4617#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4618
4619#if defined(MBEDTLS_SSL_PROTO_DTLS)
4620 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004622 *p++ = ssl->disable_datagram_packing;
4623 }
4624#endif /* MBEDTLS_SSL_PROTO_DTLS */
4625
Jerry Yuae0b2e22021-10-08 15:21:19 +08004626 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (used <= buf_len) {
4628 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004629 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004630 }
4631
4632#if defined(MBEDTLS_SSL_PROTO_DTLS)
4633 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if (used <= buf_len) {
4635 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004636 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004637 }
4638#endif /* MBEDTLS_SSL_PROTO_DTLS */
4639
4640#if defined(MBEDTLS_SSL_ALPN)
4641 {
4642 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004644 : 0;
4645
4646 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004648 *p++ = alpn_len;
4649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if (ssl->alpn_chosen != NULL) {
4651 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004652 p += alpn_len;
4653 }
4654 }
4655 }
4656#endif /* MBEDTLS_SSL_ALPN */
4657
4658 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004659 * Done
4660 */
4661 *olen = used;
4662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (used > buf_len) {
4664 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4665 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004670}
4671
4672/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004673 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004674 *
4675 * This internal version is wrapped by a public function that cleans up in
4676 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004677 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004679static int ssl_context_load(mbedtls_ssl_context *ssl,
4680 const unsigned char *buf,
4681 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004682{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004683 const unsigned char *p = buf;
4684 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004685 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004686 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004687#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004688 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004689#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004690
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004691 /*
4692 * The context should have been freshly setup or reset.
4693 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004694 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004695 * renegotiating, or if the user mistakenly loaded a session first.)
4696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4698 ssl->session != NULL) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004700 }
4701
4702 /*
4703 * We can't check that the config matches the initial one, but we can at
4704 * least check it matches the requirements for serializing.
4705 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004706 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004707#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004708 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004709#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004710 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4711 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4712 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4713 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004715 }
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004718
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004719 /*
4720 * Check version identifier
4721 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004724 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004725
4726 if (memcmp(p, ssl_serialized_context_header,
4727 sizeof(ssl_serialized_context_header)) != 0) {
4728 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4729 }
4730 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004731
4732 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004733 * Session
4734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if ((size_t) (end - p) < 4) {
4736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4737 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004738
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004739 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004740 p += 4;
4741
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004742 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004743 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004744 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004745 ssl->session_in = ssl->session;
4746 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004747 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if ((size_t) (end - p) < session_len) {
4750 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4751 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 ret = ssl_session_load(ssl->session, 1, p, session_len);
4754 if (ret != 0) {
4755 mbedtls_ssl_session_free(ssl->session);
4756 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004757 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004758
4759 p += session_len;
4760
4761 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004762 * Transform
4763 */
4764
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004765 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004766 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004767#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004768 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004769 ssl->transform_in = ssl->transform;
4770 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004771 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004772#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004773
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004774#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4776 if (prf_func == NULL) {
4777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4778 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004779
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004780 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4783 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004784
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 ret = ssl_tls12_populate_transform(ssl->transform,
4786 ssl->session->ciphersuite,
4787 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004788#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004790#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 prf_func,
4792 p, /* currently pointing to randbytes */
4793 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4794 ssl->conf->endpoint,
4795 ssl);
4796 if (ret != 0) {
4797 return ret;
4798 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004799#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004801
4802#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4803 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if ((size_t) (end - p) < 1) {
4805 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4806 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004807
4808 ssl->transform->in_cid_len = *p++;
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4812 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004815 p += ssl->transform->in_cid_len;
4816
4817 ssl->transform->out_cid_len = *p++;
4818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4821 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004824 p += ssl->transform->out_cid_len;
4825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4826
4827 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004828 * Saved fields from top-level ssl_context structure
4829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if ((size_t) (end - p) < 4) {
4831 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4832 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004833
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004834 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004835 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004836
4837#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if ((size_t) (end - p) < 16) {
4839 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4840 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004841
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004842 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004843 p += 8;
4844
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004845 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004846 p += 8;
4847#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4848
4849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if ((size_t) (end - p) < 1) {
4851 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4852 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004853
4854 ssl->disable_datagram_packing = *p++;
4855#endif /* MBEDTLS_SSL_PROTO_DTLS */
4856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4858 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4859 }
4860 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4861 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004862
4863#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if ((size_t) (end - p) < 2) {
4865 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4866 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004867
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004868 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004869 p += 2;
4870#endif /* MBEDTLS_SSL_PROTO_DTLS */
4871
4872#if defined(MBEDTLS_SSL_ALPN)
4873 {
4874 uint8_t alpn_len;
4875 const char **cur;
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if ((size_t) (end - p) < 1) {
4878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4879 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004880
4881 alpn_len = *p++;
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004884 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4886 if (strlen(*cur) == alpn_len &&
4887 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004888 ssl->alpn_chosen = *cur;
4889 break;
4890 }
4891 }
4892 }
4893
4894 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4896 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4897 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004898
4899 p += alpn_len;
4900 }
4901#endif /* MBEDTLS_SSL_ALPN */
4902
4903 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004904 * Forced fields from top-level ssl_context structure
4905 *
4906 * Most of them already set to the correct value by mbedtls_ssl_init() and
4907 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4908 */
4909 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004910 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004911
Hanno Becker361b10d2019-08-30 10:42:49 +01004912 /* Adjust pointers for header fields of outgoing records to
4913 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004915
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004916#if defined(MBEDTLS_SSL_PROTO_DTLS)
4917 ssl->in_epoch = 1;
4918#endif
4919
4920 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4921 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004922 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4923 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (ssl->handshake != NULL) {
4925 mbedtls_ssl_handshake_free(ssl);
4926 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004927 ssl->handshake = NULL;
4928 }
4929
4930 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004931 * Done - should have consumed entire buffer
4932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (p != end) {
4934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4935 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004938}
4939
4940/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004941 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004943int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4944 const unsigned char *buf,
4945 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004946{
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if (ret != 0) {
4950 mbedtls_ssl_free(context);
4951 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004954}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004955#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004956
4957/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004958 * Free an SSL context
4959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004961{
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004963 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004969#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4970 size_t out_buf_len = ssl->out_buf_len;
4971#else
4972 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4973#endif
4974
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004975 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004976 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004977 }
4978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004980#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4981 size_t in_buf_len = ssl->in_buf_len;
4982#else
4983 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4984#endif
4985
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004986 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004987 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004988 }
4989
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 if (ssl->transform) {
4991 mbedtls_ssl_transform_free(ssl->transform);
4992 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004993 }
4994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if (ssl->handshake) {
4996 mbedtls_ssl_handshake_free(ssl);
4997 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004998
4999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5001 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005002#endif
5003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 mbedtls_ssl_session_free(ssl->session_negotiate);
5005 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005006 }
5007
Ronald Cron6f135e12021-12-08 16:57:54 +01005008#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 mbedtls_ssl_transform_free(ssl->transform_application);
5010 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005011#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (ssl->session) {
5014 mbedtls_ssl_session_free(ssl->session);
5015 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005016 }
5017
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005018#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005020 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005021 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005022#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005023
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005024#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005026#endif
5027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005029
Paul Bakker86f04f42013-02-14 11:20:09 +01005030 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005032}
5033
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005034/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005035 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005037void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005038{
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005040}
5041
Gilles Peskineae270bf2021-06-02 00:05:29 +02005042/* The selection should be the same as mbedtls_x509_crt_profile_default in
5043 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005044 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005045 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005046 * about this list.
5047 */
Brett Warrene0edc842021-08-17 09:53:13 +01005048static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005049#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005050 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005051#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005052#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005053 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005054#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005055#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005056 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005057#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005058#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005059 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005060#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005061#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005062 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005063#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005064#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005065 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005066#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005067#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005068 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005069#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005070#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005071 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005072#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005073#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005074 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5075 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5076 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5077 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5078 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5079#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005080 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005081};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005082
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005083static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005084 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5085 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5086 0
5087};
5088
Ronald Crone68ab4f2022-10-05 12:46:29 +02005089#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005090
Jerry Yu909df7b2022-01-22 11:56:27 +08005091/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005092 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005093 * rules SHOULD be upheld.
5094 * - No duplicate entries.
5095 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005096 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005097 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005098 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005099static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005100
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005101#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005102 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005103 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005104 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005105 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5106#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005107
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005108#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005109 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005110 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005111 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005112 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5113#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005114
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005115#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005116 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005117 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005118 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005119 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5120#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005121
Yanray Wang1136fad2023-11-22 16:54:31 +08005122#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005123 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005124#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005125
Yanray Wang1136fad2023-11-22 16:54:31 +08005126#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005127 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005128#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005129
Yanray Wang1136fad2023-11-22 16:54:31 +08005130#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005131 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005132#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005133
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005134#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005135 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005136#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005137
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005138#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005139 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005140#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005141
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005142#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005143 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005144#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005145
Gabor Mezei15b95a62022-05-09 16:37:58 +02005146 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005147};
5148
5149/* NOTICE: see above */
5150#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5151static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005152
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005153#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005154#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005156#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005157#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5158 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005159#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005160#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005162#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005163#endif /* MBEDTLS_MD_CAN_SHA512 */
5164
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005165#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005166#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005168#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005169#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5170 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005171#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005172#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005174#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005175#endif /* MBEDTLS_MD_CAN_SHA384 */
5176
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005177#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005178#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005180#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005181#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5182 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005183#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005184#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005186#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005187#endif /* MBEDTLS_MD_CAN_SHA256 */
5188
Gabor Mezei15b95a62022-05-09 16:37:58 +02005189 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005190};
5191#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005192
Jerry Yu909df7b2022-01-22 11:56:27 +08005193/* NOTICE: see above */
5194static uint16_t ssl_preset_suiteb_sig_algs[] = {
5195
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005196#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005197 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005198 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005199 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005200 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5201#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005202
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005203#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005204 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005205 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005206 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005207 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5208#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005209
Gabor Mezei15b95a62022-05-09 16:37:58 +02005210 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005211};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005212
Jerry Yu909df7b2022-01-22 11:56:27 +08005213/* NOTICE: see above */
5214#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5215static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005216
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005217#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005218#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005220#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005221#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005222
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005223#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005224#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005226#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005227#endif /* MBEDTLS_MD_CAN_SHA384 */
5228
Gabor Mezei15b95a62022-05-09 16:37:58 +02005229 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005230};
Jerry Yu909df7b2022-01-22 11:56:27 +08005231#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5232
Ronald Crone68ab4f2022-10-05 12:46:29 +02005233#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005234
Brett Warrene0edc842021-08-17 09:53:13 +01005235static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005236#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005237 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005238#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005239#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005240 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005241#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005242 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005243};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005244
Ronald Crone68ab4f2022-10-05 12:46:29 +02005245#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005246/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005247 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005248MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005249static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005250{
5251 size_t i, j;
5252 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5255 for (j = 0; j < i; j++) {
5256 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005257 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 }
5259 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5260 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5261 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005262 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005263 }
5264 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005266}
5267
Ronald Crone68ab4f2022-10-05 12:46:29 +02005268#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005269
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005270/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005271 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005273int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5274 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005275{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005276#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005277 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005278#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005279
Ronald Crone68ab4f2022-10-05 12:46:29 +02005280#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5282 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5283 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005284 }
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5287 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5288 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005289 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005290
5291#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5293 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5294 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005295 }
5296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5298 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5299 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005300 }
5301#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005302#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005303
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005304 /* Use the functions here so that they are covered in tests,
5305 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 mbedtls_ssl_conf_endpoint(conf, endpoint);
5307 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005308
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005309 /*
5310 * Things that are common to all presets
5311 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005312#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005314 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5315#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5316 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5317#endif
5318 }
5319#endif
5320
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005321#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5322 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5323#endif
5324
5325#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5326 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5327#endif
5328
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005329#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005330 conf->f_cookie_write = ssl_cookie_write_dummy;
5331 conf->f_cookie_check = ssl_cookie_check_dummy;
5332#endif
5333
5334#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5335 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5336#endif
5337
Janos Follath088ce432017-04-10 12:42:31 +01005338#if defined(MBEDTLS_SSL_SRV_C)
5339 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005340 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005341#endif
5342
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005343#if defined(MBEDTLS_SSL_PROTO_DTLS)
5344 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5345 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5346#endif
5347
5348#if defined(MBEDTLS_SSL_RENEGOTIATION)
5349 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 memset(conf->renego_period, 0x00, 2);
5351 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005352#endif
5353
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005354#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005356 const unsigned char dhm_p[] =
5357 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5358 const unsigned char dhm_g[] =
5359 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5362 dhm_p, sizeof(dhm_p),
5363 dhm_g, sizeof(dhm_g))) != 0) {
5364 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005365 }
5366 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005367#endif
5368
Ronald Cron6f135e12021-12-08 16:57:54 +01005369#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005370
5371#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005372 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005373#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005374 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005375#endif
5376#endif /* MBEDTLS_SSL_EARLY_DATA */
5377
Jerry Yud0766ec2022-09-22 10:46:57 +08005378#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005379 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005381#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005382 /*
5383 * Allow all TLS 1.3 key exchange modes by default.
5384 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005385 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005386#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005389#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005390 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005391 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005392#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005396#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005397 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5398 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005399#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5400 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5401 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5402#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5403 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5404 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005407#endif
5408 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005409
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005410 /*
5411 * Preset-specific defaults
5412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005414 /*
5415 * NSA Suite B
5416 */
5417 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005418
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005419 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005420
5421#if defined(MBEDTLS_X509_CRT_PARSE_C)
5422 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005423#endif
5424
Ronald Crone68ab4f2022-10-05 12:46:29 +02005425#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005426#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005428 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005430#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005432#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005433
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005434#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005435 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005436#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005437 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005438 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005439
5440 /*
5441 * Default
5442 */
5443 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005444
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005445 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005446
5447#if defined(MBEDTLS_X509_CRT_PARSE_C)
5448 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5449#endif
5450
Ronald Crone68ab4f2022-10-05 12:46:29 +02005451#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005452#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005454 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005458#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005459
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005460#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005461 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005462#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005463 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005464
5465#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5466 conf->dhm_min_bitlen = 1024;
5467#endif
5468 }
5469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005471}
5472
5473/*
5474 * Free mbedtls_ssl_config
5475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005476void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005477{
5478#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 mbedtls_mpi_free(&conf->dhm_P);
5480 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005481#endif
5482
Ronald Cron73fe8df2022-10-05 14:31:43 +02005483#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005484#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005486 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5487 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005488#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005490 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005491 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005492 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005493 }
5494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005496 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005497 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005498 conf->psk_identity_len = 0;
5499 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005500#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005501
5502#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005504#endif
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005507}
5508
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005509#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005510 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005511/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005512 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005514unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005515{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5518 return MBEDTLS_SSL_SIG_RSA;
5519 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005520#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005521#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5523 return MBEDTLS_SSL_SIG_ECDSA;
5524 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005525#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005527}
5528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005530{
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005532 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005534 case MBEDTLS_PK_ECDSA:
5535 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005537 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005539 }
5540}
5541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005543{
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005545#if defined(MBEDTLS_RSA_C)
5546 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005548#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005549#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005552#endif
5553 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005555 }
5556}
Valerio Settie9646ec2023-08-02 20:02:28 +02005557#endif /* MBEDTLS_PK_C &&
5558 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005559
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005560/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005561 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005563mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005564{
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005566#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005567 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005569#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005570#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005573#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005574#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005575 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005577#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005578#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005579 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005581#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005582#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005583 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005585#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005586#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005589#endif
5590 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005592 }
5593}
5594
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005595/*
5596 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005598unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005599{
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005601#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005602 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005604#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005605#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005606 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005608#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005609#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005610 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005612#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005613#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005614 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005616#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005617#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005618 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005620#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005621#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005622 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005624#endif
5625 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005627 }
5628}
5629
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005630/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005631 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005632 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005634int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005635{
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (group_list == NULL) {
5639 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005640 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005641
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 for (; *group_list != 0; group_list++) {
5643 if (*group_list == tls_id) {
5644 return 0;
5645 }
5646 }
5647
5648 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005649}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005650
Valerio Setti49e69072023-06-27 17:27:51 +02005651#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005652/*
5653 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005655int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005656{
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005660 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005662
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005664}
Valerio Setti49e69072023-06-27 17:27:51 +02005665#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005666
Valerio Setti18c9fed2022-12-30 17:44:24 +01005667static const struct {
5668 uint16_t tls_id;
5669 mbedtls_ecp_group_id ecp_group_id;
5670 psa_ecc_family_t psa_family;
5671 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005672} tls_id_match_table[] =
5673{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005674#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005675 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005676#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005677#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005678 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005679#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005680#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005681 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005683#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005684 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005685#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005686#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005687 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005688#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005689#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005690 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005691#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005692#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005693 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005694#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005695#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005696 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005697#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005698#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005699 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005700#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005701#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005702 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005703#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005704#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005705 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005706#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005707#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005708 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005709#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005710#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005711 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005712#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005713 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005714};
5715
Gilles Peskine449bd832023-01-11 14:50:10 +01005716int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005717 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005719{
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5721 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005722 if (type != NULL) {
5723 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 }
5725 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005726 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005728 return PSA_SUCCESS;
5729 }
5730 }
5731
5732 return PSA_ERROR_NOT_SUPPORTED;
5733}
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005736{
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5738 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005739 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005741 }
5742
5743 return MBEDTLS_ECP_DP_NONE;
5744}
5745
Gilles Peskine449bd832023-01-11 14:50:10 +01005746uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005747{
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5749 i++) {
5750 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005751 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005753 }
5754
5755 return 0;
5756}
5757
Valerio Setti67419f02023-01-04 16:12:42 +01005758#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005759static const struct {
5760 uint16_t tls_id;
5761 const char *name;
5762} tls_id_curve_name_table[] =
5763{
Valerio Setti54e23792023-07-07 10:49:27 +02005764 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5765 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5766 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5767 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5768 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5769 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5770 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5771 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5772 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5773 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5774 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5775 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5776 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005777 { 0, NULL },
5778};
5779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005781{
Valerio Settiacd32c02023-06-29 18:06:29 +02005782 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5783 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5784 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005786 }
5787
5788 return NULL;
5789}
Valerio Setti67419f02023-01-04 16:12:42 +01005790#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005792#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005793int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5794 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5795 int cert_endpoint,
5796 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005797{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005798 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005799 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005800 const char *ext_oid;
5801 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005802
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005804 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005806 case MBEDTLS_KEY_EXCHANGE_RSA:
5807 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005808 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005809 break;
5810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005811 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5812 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5813 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5814 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005815 break;
5816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005817 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5818 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005819 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005820 break;
5821
5822 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823 case MBEDTLS_KEY_EXCHANGE_NONE:
5824 case MBEDTLS_KEY_EXCHANGE_PSK:
5825 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5826 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005827 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005828 usage = 0;
5829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005831 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5832 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005833 }
5834
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005836 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005837 ret = -1;
5838 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005841 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5843 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005844 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005846 }
5847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005849 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005850 ret = -1;
5851 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005852
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005854}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005855#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005856
Jerry Yu148165c2021-09-24 23:20:59 +08005857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005858int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5859 const mbedtls_md_type_t md,
5860 unsigned char *dst,
5861 size_t dst_len,
5862 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005863{
Ronald Cronf6893e12022-01-07 22:09:01 +01005864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5865 psa_hash_operation_t *hash_operation_to_clone;
5866 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5867
Jerry Yu148165c2021-09-24 23:20:59 +08005868 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005871#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 case MBEDTLS_MD_SHA384:
5873 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5874 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005875#endif
5876
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005877#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 case MBEDTLS_MD_SHA256:
5879 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5880 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005881#endif
5882
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 default:
5884 goto exit;
5885 }
5886
5887 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5888 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005889 goto exit;
5890 }
5891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5893 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005894 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005896
5897exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005898#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5899 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005900 (void) ssl;
5901#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005902 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005903}
5904#else /* MBEDTLS_USE_PSA_CRYPTO */
5905
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005906#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005907MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005908static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5909 unsigned char *dst,
5910 size_t dst_len,
5911 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005912{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005913 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005914 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 if (dst_len < 48) {
5917 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5918 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005919
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005920 mbedtls_md_init(&sha384);
5921 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005922 if (ret != 0) {
5923 goto exit;
5924 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005925 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005926 if (ret != 0) {
5927 goto exit;
5928 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005929
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005930 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005931 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005932 goto exit;
5933 }
5934
5935 *olen = 48;
5936
5937exit:
5938
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005939 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005941}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005942#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005943
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005944#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005945MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005946static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5947 unsigned char *dst,
5948 size_t dst_len,
5949 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005950{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005951 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005952 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005953
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if (dst_len < 32) {
5955 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5956 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005957
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005958 mbedtls_md_init(&sha256);
5959 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5960 if (ret != 0) {
5961 goto exit;
5962 }
5963 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5964 if (ret != 0) {
5965 goto exit;
5966 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005967
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005968 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5969 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005970 goto exit;
5971 }
5972
5973 *olen = 32;
5974
5975exit:
5976
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005977 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005979}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005980#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5983 const mbedtls_md_type_t md,
5984 unsigned char *dst,
5985 size_t dst_len,
5986 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005987{
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005989
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005990#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 case MBEDTLS_MD_SHA384:
5992 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005993#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005994
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005995#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 case MBEDTLS_MD_SHA256:
5997 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005998#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005999
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006001#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6002 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 (void) ssl;
6004 (void) dst;
6005 (void) dst_len;
6006 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006007#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006009 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006011}
XiaokangQian647719a2021-12-07 09:16:29 +00006012
Jerry Yu148165c2021-09-24 23:20:59 +08006013#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006014
Ronald Crone68ab4f2022-10-05 12:46:29 +02006015#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006016/* mbedtls_ssl_parse_sig_alg_ext()
6017 *
6018 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6019 * value (TLS 1.3 RFC8446):
6020 * enum {
6021 * ....
6022 * ecdsa_secp256r1_sha256( 0x0403 ),
6023 * ecdsa_secp384r1_sha384( 0x0503 ),
6024 * ecdsa_secp521r1_sha512( 0x0603 ),
6025 * ....
6026 * } SignatureScheme;
6027 *
6028 * struct {
6029 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6030 * } SignatureSchemeList;
6031 *
6032 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6033 * value (TLS 1.2 RFC5246):
6034 * enum {
6035 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6036 * sha512(6), (255)
6037 * } HashAlgorithm;
6038 *
6039 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6040 * SignatureAlgorithm;
6041 *
6042 * struct {
6043 * HashAlgorithm hash;
6044 * SignatureAlgorithm signature;
6045 * } SignatureAndHashAlgorithm;
6046 *
6047 * SignatureAndHashAlgorithm
6048 * supported_signature_algorithms<2..2^16-2>;
6049 *
6050 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6051 * generalization of the TLS 1.2 signature algorithm extension.
6052 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6053 * `SignatureScheme` field of TLS 1.3
6054 *
6055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006056int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6057 const unsigned char *buf,
6058 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006059{
6060 const unsigned char *p = buf;
6061 size_t supported_sig_algs_len = 0;
6062 const unsigned char *supported_sig_algs_end;
6063 uint16_t sig_alg;
6064 uint32_t common_idx = 0;
6065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6067 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006068 p += 2;
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 memset(ssl->handshake->received_sig_algs, 0,
6071 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006074 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 while (p < supported_sig_algs_end) {
6076 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6077 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006078 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6080 sig_alg,
6081 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006082#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6084 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6085 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006086 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006087 }
6088#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006089
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6091 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006094 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6095 common_idx += 1;
6096 }
6097 }
6098 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (p != end) {
6100 MBEDTLS_SSL_DEBUG_MSG(1,
6101 ("Signature algorithms extension length misaligned"));
6102 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6103 MBEDTLS_ERR_SSL_DECODE_ERROR);
6104 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006105 }
6106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (common_idx == 0) {
6108 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6109 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6110 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6111 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006112 }
6113
Gabor Mezei15b95a62022-05-09 16:37:58 +02006114 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006116}
6117
Ronald Crone68ab4f2022-10-05 12:46:29 +02006118#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006119
Jerry Yudc7bd172022-02-17 13:44:15 +08006120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6121
6122#if defined(MBEDTLS_USE_PSA_CRYPTO)
6123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6125 mbedtls_svc_key_id_t key,
6126 psa_algorithm_t alg,
6127 const unsigned char *raw_psk, size_t raw_psk_length,
6128 const unsigned char *seed, size_t seed_length,
6129 const unsigned char *label, size_t label_length,
6130 const unsigned char *other_secret,
6131 size_t other_secret_length,
6132 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006133{
6134 psa_status_t status;
6135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 status = psa_key_derivation_setup(derivation, alg);
6137 if (status != PSA_SUCCESS) {
6138 return status;
6139 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6142 status = psa_key_derivation_input_bytes(derivation,
6143 PSA_KEY_DERIVATION_INPUT_SEED,
6144 seed, seed_length);
6145 if (status != PSA_SUCCESS) {
6146 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006147 }
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 if (other_secret != NULL) {
6150 status = psa_key_derivation_input_bytes(derivation,
6151 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6152 other_secret, other_secret_length);
6153 if (status != PSA_SUCCESS) {
6154 return status;
6155 }
6156 }
6157
6158 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006159 status = psa_key_derivation_input_bytes(
6160 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 raw_psk, raw_psk_length);
6162 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006163 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006165 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 if (status != PSA_SUCCESS) {
6167 return status;
6168 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 status = psa_key_derivation_input_bytes(derivation,
6171 PSA_KEY_DERIVATION_INPUT_LABEL,
6172 label, label_length);
6173 if (status != PSA_SUCCESS) {
6174 return status;
6175 }
6176 } else {
6177 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006178 }
6179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 status = psa_key_derivation_set_capacity(derivation, capacity);
6181 if (status != PSA_SUCCESS) {
6182 return status;
6183 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006186}
6187
Andrzej Kurek57d10632022-10-24 10:32:01 -04006188#if defined(PSA_WANT_ALG_SHA_384) || \
6189 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006190MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006191static int tls_prf_generic(mbedtls_md_type_t md_type,
6192 const unsigned char *secret, size_t slen,
6193 const char *label,
6194 const unsigned char *random, size_t rlen,
6195 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006196{
6197 psa_status_t status;
6198 psa_algorithm_t alg;
6199 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6200 psa_key_derivation_operation_t derivation =
6201 PSA_KEY_DERIVATION_OPERATION_INIT;
6202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006204 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
6209 /* Normally a "secret" should be long enough to be impossible to
6210 * find by brute force, and in particular should not be empty. But
6211 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6212 * and for this use case it makes sense to have a 0-length "secret".
6213 * Since the key API doesn't allow importing a key of length 0,
6214 * keep master_key=0, which setup_psa_key_derivation() understands
6215 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6219 psa_set_key_algorithm(&key_attributes, alg);
6220 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6223 if (status != PSA_SUCCESS) {
6224 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6225 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006226 }
6227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 status = setup_psa_key_derivation(&derivation,
6229 master_key, alg,
6230 NULL, 0,
6231 random, rlen,
6232 (unsigned char const *) label,
6233 (size_t) strlen(label),
6234 NULL, 0,
6235 dlen);
6236 if (status != PSA_SUCCESS) {
6237 psa_key_derivation_abort(&derivation);
6238 psa_destroy_key(master_key);
6239 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006240 }
6241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6243 if (status != PSA_SUCCESS) {
6244 psa_key_derivation_abort(&derivation);
6245 psa_destroy_key(master_key);
6246 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 }
6248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 status = psa_key_derivation_abort(&derivation);
6250 if (status != PSA_SUCCESS) {
6251 psa_destroy_key(master_key);
6252 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 }
6254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if (!mbedtls_svc_key_id_is_null(master_key)) {
6256 status = psa_destroy_key(master_key);
6257 }
6258 if (status != PSA_SUCCESS) {
6259 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6260 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006263}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006264#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006265#else /* MBEDTLS_USE_PSA_CRYPTO */
6266
Andrzej Kurek57d10632022-10-24 10:32:01 -04006267#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006268 (defined(MBEDTLS_MD_CAN_SHA256) || \
6269 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006271static int tls_prf_generic(mbedtls_md_type_t md_type,
6272 const unsigned char *secret, size_t slen,
6273 const char *label,
6274 const unsigned char *random, size_t rlen,
6275 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006276{
6277 size_t nb;
6278 size_t i, j, k, md_len;
6279 unsigned char *tmp;
6280 size_t tmp_len = 0;
6281 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6282 const mbedtls_md_info_t *md_info;
6283 mbedtls_md_context_t md_ctx;
6284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6289 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6290 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006291
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 tmp_len = md_len + strlen(label) + rlen;
6295 tmp = mbedtls_calloc(1, tmp_len);
6296 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006297 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6298 goto exit;
6299 }
6300
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 nb = strlen(label);
6302 memcpy(tmp + md_len, label, nb);
6303 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006304 nb += rlen;
6305
6306 /*
6307 * Compute P_<hash>(secret, label + random)[0..dlen]
6308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006310 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006312
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6314 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 }
6317 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6318 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006319 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 }
6321 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6322 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006323 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006325
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 for (i = 0; i < dlen; i += md_len) {
6327 ret = mbedtls_md_hmac_reset(&md_ctx);
6328 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006329 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 }
6331 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6332 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006333 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 }
6335 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6336 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006337 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 ret = mbedtls_md_hmac_reset(&md_ctx);
6341 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 }
6344 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6345 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006346 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 }
6348 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6349 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006350 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006352
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006354
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006356 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006358 }
6359
6360exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 if (tmp != NULL) {
6364 mbedtls_platform_zeroize(tmp, tmp_len);
6365 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006366
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006370
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006372}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006373#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006374#endif /* MBEDTLS_USE_PSA_CRYPTO */
6375
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006376#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006378static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6379 const char *label,
6380 const unsigned char *random, size_t rlen,
6381 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006382{
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6384 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006385}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006386#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006387
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006388#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006389MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006390static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6391 const char *label,
6392 const unsigned char *random, size_t rlen,
6393 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006394{
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6396 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006397}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006398#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006399
Jerry Yuf009d862022-02-17 14:01:37 +08006400/*
6401 * Set appropriate PRF function and other SSL / TLS1.2 functions
6402 *
6403 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006404 * - hash associated with the ciphersuite (only used by TLS 1.2)
6405 *
6406 * Outputs:
6407 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6408 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006409MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006410static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6411 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006412{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006413#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006415 handshake->tls_prf = tls_prf_sha384;
6416 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6417 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006419#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006420#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006421 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006422 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006423 handshake->tls_prf = tls_prf_sha256;
6424 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6425 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6426 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006427#else
Jerry Yuf009d862022-02-17 14:01:37 +08006428 {
Jerry Yuf009d862022-02-17 14:01:37 +08006429 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006430 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006432 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006433#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006436}
Jerry Yud6ab2352022-02-17 14:03:43 +08006437
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006438/*
6439 * Compute master secret if needed
6440 *
6441 * Parameters:
6442 * [in/out] handshake
6443 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6444 * (PSA-PSK) ciphersuite_info, psk_opaque
6445 * [out] premaster (cleared)
6446 * [out] master
6447 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6448 * debug: conf->f_dbg, conf->p_dbg
6449 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006450 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006452MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006453static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6454 unsigned char *master,
6455 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006456{
6457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6458
6459 /* cf. RFC 5246, Section 8.1:
6460 * "The master secret is always exactly 48 bytes in length." */
6461 size_t const master_secret_len = 48;
6462
6463#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6464 unsigned char session_hash[48];
6465#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6466
6467 /* The label for the KDF used for key expansion.
6468 * This is either "master secret" or "extended master secret"
6469 * depending on whether the Extended Master Secret extension
6470 * is used. */
6471 char const *lbl = "master secret";
6472
Przemek Stekielae4ed302022-04-05 17:15:55 +02006473 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474 * - If the Extended Master Secret extension is not used,
6475 * this is ClientHello.Random + ServerHello.Random
6476 * (see Sect. 8.1 in RFC 5246).
6477 * - If the Extended Master Secret extension is used,
6478 * this is the transcript of the handshake so far.
6479 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006480 unsigned char const *seed = handshake->randbytes;
6481 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006482
6483#if !defined(MBEDTLS_DEBUG_C) && \
6484 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6485 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006487 ssl = NULL; /* make sure we don't use it except for those cases */
6488 (void) ssl;
6489#endif
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 if (handshake->resume != 0) {
6492 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6493 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006494 }
6495
6496#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006498 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006499 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006500 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6501 if (ret != 0) {
6502 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6503 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6506 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006507 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006508#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006509
Przemek Stekiel99114f32022-04-22 11:20:09 +02006510#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006511 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513 /* Perform PSK-to-MS expansion in a single step. */
6514 psa_status_t status;
6515 psa_algorithm_t alg;
6516 mbedtls_svc_key_id_t psk;
6517 psa_key_derivation_operation_t derivation =
6518 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006519 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006530
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006531 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006535 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006536 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006537 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006538 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006539 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006540 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006541 other_secret_len = 48;
6542 other_secret = handshake->premaster + 2;
6543 break;
6544 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006545 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006546 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6547 other_secret = handshake->premaster + 2;
6548 break;
6549 default:
6550 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006551 }
6552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 status = setup_psa_key_derivation(&derivation, psk, alg,
6554 ssl->conf->psk, ssl->conf->psk_len,
6555 seed, seed_len,
6556 (unsigned char const *) lbl,
6557 (size_t) strlen(lbl),
6558 other_secret, other_secret_len,
6559 master_secret_len);
6560 if (status != PSA_SUCCESS) {
6561 psa_key_derivation_abort(&derivation);
6562 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006563 }
6564
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 status = psa_key_derivation_output_bytes(&derivation,
6566 master,
6567 master_secret_len);
6568 if (status != PSA_SUCCESS) {
6569 psa_key_derivation_abort(&derivation);
6570 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006571 }
6572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 status = psa_key_derivation_abort(&derivation);
6574 if (status != PSA_SUCCESS) {
6575 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6576 }
6577 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006578#endif
6579 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006580#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6582 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006583 psa_status_t status;
6584 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6585 psa_key_derivation_operation_t derivation =
6586 PSA_KEY_DERIVATION_OPERATION_INIT;
6587
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006589
6590 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6591
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 status = psa_key_derivation_setup(&derivation, alg);
6593 if (status != PSA_SUCCESS) {
6594 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006595 }
6596
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 status = psa_key_derivation_set_capacity(&derivation,
6598 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6599 if (status != PSA_SUCCESS) {
6600 psa_key_derivation_abort(&derivation);
6601 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006602 }
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6605 &derivation);
6606 if (status != PSA_SUCCESS) {
6607 psa_key_derivation_abort(&derivation);
6608 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006609 }
6610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 status = psa_key_derivation_output_bytes(&derivation,
6612 handshake->premaster,
6613 handshake->pmslen);
6614 if (status != PSA_SUCCESS) {
6615 psa_key_derivation_abort(&derivation);
6616 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6617 }
6618
6619 status = psa_key_derivation_abort(&derivation);
6620 if (status != PSA_SUCCESS) {
6621 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006622 }
6623 }
6624#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006625 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6626 lbl, seed, seed_len,
6627 master,
6628 master_secret_len);
6629 if (ret != 0) {
6630 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6631 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006632 }
6633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6635 handshake->premaster,
6636 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 mbedtls_platform_zeroize(handshake->premaster,
6639 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006640 }
6641
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006643}
6644
Gilles Peskine449bd832023-01-11 14:50:10 +01006645int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006646{
6647 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6648 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6649 ssl->handshake->ciphersuite_info;
6650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006652
6653 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006655 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (ret != 0) {
6657 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6658 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006659 }
6660
6661 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 ret = ssl_compute_master(ssl->handshake,
6663 ssl->session_negotiate->master,
6664 ssl);
6665 if (ret != 0) {
6666 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6667 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006668 }
6669
6670 /* Swap the client and server random values:
6671 * - MS derivation wanted client+server (RFC 5246 8.1)
6672 * - key derivation wants server+client (RFC 5246 6.3) */
6673 {
6674 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 memcpy(tmp, ssl->handshake->randbytes, 64);
6676 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6677 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6678 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006679 }
6680
6681 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6683 ssl->session_negotiate->ciphersuite,
6684 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006685#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006687#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 ssl->handshake->tls_prf,
6689 ssl->handshake->randbytes,
6690 ssl->tls_version,
6691 ssl->conf->endpoint,
6692 ssl);
6693 if (ret != 0) {
6694 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6695 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006696 }
6697
6698 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6700 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006703
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006705}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006708{
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006710#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006711 case MBEDTLS_SSL_HASH_SHA384:
6712 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6713 break;
6714#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006715#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006716 case MBEDTLS_SSL_HASH_SHA256:
6717 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6718 break;
6719#endif
6720 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006722 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006723#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6724 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006725 (void) ssl;
6726#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006728}
6729
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006730#if defined(MBEDTLS_USE_PSA_CRYPTO)
6731static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6732 const psa_hash_operation_t *hs_op,
6733 size_t buffer_size,
6734 unsigned char *hash,
6735 size_t *hlen)
6736{
6737 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006738 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006739
6740#if !defined(MBEDTLS_DEBUG_C)
6741 (void) ssl;
6742#endif
6743 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006744 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006745 if (status != PSA_SUCCESS) {
6746 goto exit;
6747 }
6748
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006749 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006750 if (status != PSA_SUCCESS) {
6751 goto exit;
6752 }
6753
6754 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6755 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6756
6757exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006758 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006759 return mbedtls_md_error_from_psa(status);
6760}
6761#else
6762static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6763 const mbedtls_md_context_t *hs_ctx,
6764 unsigned char *hash,
6765 size_t *hlen)
6766{
6767 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006768 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006769
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006770 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006771
6772#if !defined(MBEDTLS_DEBUG_C)
6773 (void) ssl;
6774#endif
6775 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6776
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006777 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006778 if (ret != 0) {
6779 goto exit;
6780 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006781 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006782 if (ret != 0) {
6783 goto exit;
6784 }
6785
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006786 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006787 if (ret != 0) {
6788 goto exit;
6789 }
6790
6791 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6792
6793 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6794 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6795
6796exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006797 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006798 return ret;
6799}
6800#endif /* MBEDTLS_USE_PSA_CRYPTO */
6801
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006802#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006803int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6804 unsigned char *hash,
6805 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006806{
6807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006808 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6809 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006810#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006811 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6812 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006813#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006814}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006815#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006816
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006817#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006818int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6819 unsigned char *hash,
6820 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006821{
6822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006823 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6824 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006825#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006826 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6827 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006828#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006829}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006830#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006831
Neil Armstrong80f6f322022-05-03 17:56:38 +02006832#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6833 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006834int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006835{
6836 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006838 const unsigned char *psk = NULL;
6839 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006843 /*
6844 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006845 * checked before calling this function.
6846 *
6847 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006848 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6851 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6852 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006853 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006854 }
6855
6856 /*
6857 * PMS = struct {
6858 * opaque other_secret<0..2^16-1>;
6859 * opaque psk<0..2^16-1>;
6860 * };
6861 * with "other_secret" depending on the particular key exchange
6862 */
6863#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6865 if (end - p < 2) {
6866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6867 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006868
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006870 p += 2;
6871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if (end < p || (size_t) (end - p) < psk_len) {
6873 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6874 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006877 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006879#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6880#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006882 /*
6883 * other_secret already set by the ClientKeyExchange message,
6884 * and is 48 bytes long
6885 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 if (end - p < 2) {
6887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6888 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006889
6890 *p++ = 0;
6891 *p++ = 48;
6892 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006894#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6895#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6898 size_t len;
6899
6900 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006902 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6904 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6905 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006906 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006908 p += 2 + len;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6911 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006912#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006913#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6916 size_t zlen;
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006919 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6921 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6922 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006923 }
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006926 p += 2 + zlen;
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6929 MBEDTLS_DEBUG_ECDH_Z);
6930 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006931#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006932 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6934 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006935 }
6936
6937 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (end - p < 2) {
6939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6940 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006943 p += 2;
6944
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (end < p || (size_t) (end - p) < psk_len) {
6946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6947 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006948
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006950 p += psk_len;
6951
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006952 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006955}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006956#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006957
6958#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006960static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006961
6962#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006963int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006964{
6965 /* If renegotiation is not enforced, retransmit until we would reach max
6966 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006968 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6969 unsigned char doublings = 1;
6970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006972 ++doublings;
6973 ratio >>= 1;
6974 }
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (++ssl->renego_records_seen > doublings) {
6977 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6978 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006979 }
6980 }
6981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006983}
6984#endif
6985#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006986
Jerry Yud9526692022-02-17 14:23:47 +08006987/*
6988 * Handshake functions
6989 */
6990#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6991/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006992int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006993{
6994 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6995 ssl->handshake->ciphersuite_info;
6996
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7000 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007001 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007003 }
7004
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7006 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007007}
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007010{
7011 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7012 ssl->handshake->ciphersuite_info;
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7017 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007018 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007020 }
7021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7023 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007024}
7025
7026#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7027/* Some certificate support -> implement write and parse */
7028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007030{
7031 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7032 size_t i, n;
7033 const mbedtls_x509_crt *crt;
7034 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7035 ssl->handshake->ciphersuite_info;
7036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7040 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007041 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007043 }
7044
7045#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7047 if (ssl->handshake->client_auth == 0) {
7048 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007049 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007051 }
7052 }
7053#endif /* MBEDTLS_SSL_CLI_C */
7054#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7056 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007057 /* Should never happen because we shouldn't have picked the
7058 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007060 }
7061 }
7062#endif
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007065
7066 /*
7067 * 0 . 0 handshake type
7068 * 1 . 3 handshake length
7069 * 4 . 6 length of all certs
7070 * 7 . 9 length of cert. 1
7071 * 10 . n-1 peer certificate
7072 * n . n+2 length of cert. 2
7073 * n+3 . ... upper level cert, etc.
7074 */
7075 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007079 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7081 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7082 " > %" MBEDTLS_PRINTF_SIZET,
7083 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7084 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007085 }
7086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7088 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7089 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007092 i += n; crt = crt->next;
7093 }
7094
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7096 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7097 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007098
7099 ssl->out_msglen = i;
7100 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7101 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7102
7103 ssl->state++;
7104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7106 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7107 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007108 }
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007113}
7114
7115#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7116
7117#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007118MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007119static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7120 unsigned char *crt_buf,
7121 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007122{
7123 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 if (peer_crt == NULL) {
7126 return -1;
7127 }
Jerry Yud9526692022-02-17 14:23:47 +08007128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 if (peer_crt->raw.len != crt_buf_len) {
7130 return -1;
7131 }
Jerry Yud9526692022-02-17 14:23:47 +08007132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007134}
7135#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007136MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007137static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7138 unsigned char *crt_buf,
7139 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007140{
7141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7142 unsigned char const * const peer_cert_digest =
7143 ssl->session->peer_cert_digest;
7144 mbedtls_md_type_t const peer_cert_digest_type =
7145 ssl->session->peer_cert_digest_type;
7146 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007148 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7149 size_t digest_len;
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 if (peer_cert_digest == NULL || digest_info == NULL) {
7152 return -1;
7153 }
Jerry Yud9526692022-02-17 14:23:47 +08007154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 digest_len = mbedtls_md_get_size(digest_info);
7156 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7157 return -1;
7158 }
Jerry Yud9526692022-02-17 14:23:47 +08007159
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7161 if (ret != 0) {
7162 return -1;
7163 }
Jerry Yud9526692022-02-17 14:23:47 +08007164
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007166}
7167#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7168#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7169
7170/*
7171 * Once the certificate message is read, parse it into a cert chain and
7172 * perform basic checks, but leave actual verification to the caller
7173 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007174MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007175static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7176 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007177{
7178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7179#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007181#endif
7182 size_t i, n;
7183 uint8_t alert;
7184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7186 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7187 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7188 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7189 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007190 }
7191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7193 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7194 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7195 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007196 }
7197
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7199 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7200 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7201 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7202 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007203 }
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007206
7207 /*
7208 * Same message structure as in mbedtls_ssl_write_certificate()
7209 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007210 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007211
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 if (ssl->in_msg[i] != 0 ||
7213 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7214 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7215 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7216 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7217 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007218 }
7219
7220 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7221 i += 3;
7222
7223 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007225 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 if (i + 3 > ssl->in_hslen) {
7227 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7228 mbedtls_ssl_send_alert_message(ssl,
7229 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7230 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7231 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007232 }
7233 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7234 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 if (ssl->in_msg[i] != 0) {
7236 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7237 mbedtls_ssl_send_alert_message(ssl,
7238 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7239 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7240 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007241 }
7242
7243 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007244 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007245 i += 3;
7246
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 if (n < 128 || i + n > ssl->in_hslen) {
7248 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7249 mbedtls_ssl_send_alert_message(ssl,
7250 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7251 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7252 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007253 }
7254
7255 /* Check if we're handling the first CRT in the chain. */
7256#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007258 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007260 /* During client-side renegotiation, check that the server's
7261 * end-CRTs hasn't changed compared to the initial handshake,
7262 * mitigating the triple handshake attack. On success, reuse
7263 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7265 if (ssl_check_peer_crt_unchanged(ssl,
7266 &ssl->in_msg[i],
7267 n) != 0) {
7268 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7269 mbedtls_ssl_send_alert_message(ssl,
7270 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7271 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7272 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007273 }
7274
7275 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007277 }
7278#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7279
7280 /* Parse the next certificate in the chain. */
7281#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007283#else
7284 /* If we don't need to store the CRT chain permanently, parse
7285 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007287#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007289 case 0: /*ok*/
7290 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7291 /* Ignore certificate with an unknown algorithm: maybe a
7292 prior certificate was already trusted. */
7293 break;
7294
7295 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7296 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7297 goto crt_parse_der_failed;
7298
7299 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7300 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7301 goto crt_parse_der_failed;
7302
7303 default:
7304 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007305crt_parse_der_failed:
7306 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7307 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7308 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007309 }
7310
7311 i += n;
7312 }
7313
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7315 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007316}
7317
7318#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007319MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007320static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007321{
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7323 return -1;
7324 }
Jerry Yud9526692022-02-17 14:23:47 +08007325
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007327 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7328 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7330 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7331 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007332 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007334}
7335#endif /* MBEDTLS_SSL_SRV_C */
7336
7337/* Check if a certificate message is expected.
7338 * Return either
7339 * - SSL_CERTIFICATE_EXPECTED, or
7340 * - SSL_CERTIFICATE_SKIP
7341 * indicating whether a Certificate message is expected or not.
7342 */
7343#define SSL_CERTIFICATE_EXPECTED 0
7344#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007345MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007346static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7347 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007348{
7349 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7350 ssl->handshake->ciphersuite_info;
7351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7353 return SSL_CERTIFICATE_SKIP;
7354 }
Jerry Yud9526692022-02-17 14:23:47 +08007355
7356#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7358 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7359 return SSL_CERTIFICATE_SKIP;
7360 }
Jerry Yud9526692022-02-17 14:23:47 +08007361
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007363 ssl->session_negotiate->verify_result =
7364 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007366 }
7367 }
7368#else
7369 ((void) authmode);
7370#endif /* MBEDTLS_SSL_SRV_C */
7371
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007373}
7374
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007375MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007376static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7377 int authmode,
7378 mbedtls_x509_crt *chain,
7379 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007380{
7381 int ret = 0;
7382 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7383 ssl->handshake->ciphersuite_info;
7384 int have_ca_chain = 0;
7385
7386 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7387 void *p_vrfy;
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7390 return 0;
7391 }
Jerry Yud9526692022-02-17 14:23:47 +08007392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 if (ssl->f_vrfy != NULL) {
7394 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007395 f_vrfy = ssl->f_vrfy;
7396 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 } else {
7398 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007399 f_vrfy = ssl->conf->f_vrfy;
7400 p_vrfy = ssl->conf->p_vrfy;
7401 }
7402
7403 /*
7404 * Main check: verify certificate
7405 */
7406#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007408 ((void) rs_ctx);
7409 have_ca_chain = 1;
7410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007412 ret = mbedtls_x509_crt_verify_with_ca_cb(
7413 chain,
7414 ssl->conf->f_ca_cb,
7415 ssl->conf->p_ca_cb,
7416 ssl->conf->cert_profile,
7417 ssl->hostname,
7418 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 f_vrfy, p_vrfy);
7420 } else
Jerry Yud9526692022-02-17 14:23:47 +08007421#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7422 {
7423 mbedtls_x509_crt *ca_chain;
7424 mbedtls_x509_crl *ca_crl;
7425
7426#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 ca_chain = ssl->handshake->sni_ca_chain;
7429 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 } else
Jerry Yud9526692022-02-17 14:23:47 +08007431#endif
7432 {
7433 ca_chain = ssl->conf->ca_chain;
7434 ca_crl = ssl->conf->ca_crl;
7435 }
7436
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 }
Jerry Yud9526692022-02-17 14:23:47 +08007440
7441 ret = mbedtls_x509_crt_verify_restartable(
7442 chain,
7443 ca_chain, ca_crl,
7444 ssl->conf->cert_profile,
7445 ssl->hostname,
7446 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007448 }
7449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (ret != 0) {
7451 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007452 }
7453
7454#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7456 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7457 }
Jerry Yud9526692022-02-17 14:23:47 +08007458#endif
7459
7460 /*
7461 * Secondary checks: always done, but change 'ret' only if it was 0
7462 */
7463
Valerio Settiacd32c02023-06-29 18:06:29 +02007464#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007465 {
7466 const mbedtls_pk_context *pk = &chain->pk;
7467
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007468 /* If certificate uses an EC key, make sure the curve is OK.
7469 * This is a public key, so it can't be opaque, so can_do() is a good
7470 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007472 /* and in the unlikely case the above assumption no longer holds
7473 * we are making sure that pk_ec() here does not return a NULL
7474 */
Valerio Settif9362b72023-11-29 08:42:27 +01007475 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007476 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7477 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007479 }
Valerio Setti97207782023-05-18 18:59:06 +02007480 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007481 ssl->session_negotiate->verify_result |=
7482 MBEDTLS_X509_BADCERT_BAD_KEY;
7483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7485 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007486 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007488 }
Jerry Yud9526692022-02-17 14:23:47 +08007489 }
7490 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007491#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (mbedtls_ssl_check_cert_usage(chain,
7494 ciphersuite_info,
7495 !ssl->conf->endpoint,
7496 &ssl->session_negotiate->verify_result) != 0) {
7497 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7498 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007499 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 }
Jerry Yud9526692022-02-17 14:23:47 +08007501 }
7502
7503 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7504 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7505 * with details encoded in the verification flags. All other kinds
7506 * of error codes, including those from the user provided f_vrfy
7507 * functions, are treated as fatal and lead to a failure of
7508 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7510 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7511 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007512 ret = 0;
7513 }
7514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7516 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007517 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7518 }
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007521 uint8_t alert;
7522
7523 /* The certificate may have been rejected for several reasons.
7524 Pick one and send the corresponding alert. Which alert to send
7525 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007527 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007529 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007531 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007533 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007535 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007537 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007539 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007541 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007543 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007545 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007547 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 }
7549 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7550 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007551 }
7552
7553#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if (ssl->session_negotiate->verify_result != 0) {
7555 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7556 (unsigned int) ssl->session_negotiate->verify_result));
7557 } else {
7558 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007559 }
7560#endif /* MBEDTLS_DEBUG_C */
7561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007563}
7564
7565#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007567static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7568 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007569{
7570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7571 /* Remember digest of the peer's end-CRT. */
7572 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7574 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7575 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7576 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7577 mbedtls_ssl_send_alert_message(ssl,
7578 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7579 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007582 }
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 ret = mbedtls_md(mbedtls_md_info_from_type(
7585 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7586 start, len,
7587 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007588
7589 ssl->session_negotiate->peer_cert_digest_type =
7590 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7591 ssl->session_negotiate->peer_cert_digest_len =
7592 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007595}
7596
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007597MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007598static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7599 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007600{
7601 unsigned char *end = start + len;
7602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7603
7604 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7606 ret = mbedtls_pk_parse_subpubkey(&start, end,
7607 &ssl->handshake->peer_pubkey);
7608 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007609 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007611 }
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007614}
7615#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7616
Gilles Peskine449bd832023-01-11 14:50:10 +01007617int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007618{
7619 int ret = 0;
7620 int crt_expected;
7621#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7622 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7623 ? ssl->handshake->sni_authmode
7624 : ssl->conf->authmode;
7625#else
7626 const int authmode = ssl->conf->authmode;
7627#endif
7628 void *rs_ctx = NULL;
7629 mbedtls_x509_crt *chain = NULL;
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7634 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7635 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007636 goto exit;
7637 }
7638
7639#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ssl->handshake->ecrs_enabled &&
7641 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007642 chain = ssl->handshake->ecrs_peer_cert;
7643 ssl->handshake->ecrs_peer_cert = NULL;
7644 goto crt_verify;
7645 }
7646#endif
7647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007649 /* mbedtls_ssl_read_record may have sent an alert already. We
7650 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007652 goto exit;
7653 }
7654
7655#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007657 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007660 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 }
Jerry Yud9526692022-02-17 14:23:47 +08007662
7663 goto exit;
7664 }
7665#endif /* MBEDTLS_SSL_SRV_C */
7666
7667 /* Clear existing peer CRT structure in case we tried to
7668 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7672 if (chain == NULL) {
7673 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7674 sizeof(mbedtls_x509_crt)));
7675 mbedtls_ssl_send_alert_message(ssl,
7676 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7677 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007678
7679 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7680 goto exit;
7681 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 ret = ssl_parse_certificate_chain(ssl, chain);
7685 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007686 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 }
Jerry Yud9526692022-02-17 14:23:47 +08007688
7689#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007691 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 }
Jerry Yud9526692022-02-17 14:23:47 +08007693
7694crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007696 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698#endif
7699
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 ret = ssl_parse_certificate_verify(ssl, authmode,
7701 chain, rs_ctx);
7702 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007703 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 }
Jerry Yud9526692022-02-17 14:23:47 +08007705
7706#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7707 {
7708 unsigned char *crt_start, *pk_start;
7709 size_t crt_len, pk_len;
7710
7711 /* We parse the CRT chain without copying, so
7712 * these pointers point into the input buffer,
7713 * and are hence still valid after freeing the
7714 * CRT chain. */
7715
7716 crt_start = chain->raw.p;
7717 crt_len = chain->raw.len;
7718
7719 pk_start = chain->pk_raw.p;
7720 pk_len = chain->pk_raw.len;
7721
7722 /* Free the CRT structures before computing
7723 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 mbedtls_x509_crt_free(chain);
7725 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007726 chain = NULL;
7727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7729 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007730 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 }
Jerry Yud9526692022-02-17 14:23:47 +08007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7734 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007735 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 }
Jerry Yud9526692022-02-17 14:23:47 +08007737 }
7738#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7739 /* Pass ownership to session structure. */
7740 ssl->session_negotiate->peer_cert = chain;
7741 chain = NULL;
7742#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7743
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007745
7746exit:
7747
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007749 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 }
Jerry Yud9526692022-02-17 14:23:47 +08007751
7752#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007754 ssl->handshake->ecrs_peer_cert = chain;
7755 chain = NULL;
7756 }
7757#endif
7758
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 if (chain != NULL) {
7760 mbedtls_x509_crt_free(chain);
7761 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007762 }
7763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007765}
7766#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7767
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007768static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7769 unsigned char *padbuf, size_t hlen,
7770 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007771{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007772 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007773 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007774#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007775 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007776 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007777 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007778 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007779#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007781 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007782 mbedtls_md_context_t cloned_ctx;
7783 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007784#endif
7785
7786 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007788 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007790
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007792 ? "client finished"
7793 : "server finished";
7794
7795#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007796 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007797
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007798 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007800 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007801 }
7802
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007803 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007805 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007806 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007807 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007808#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007809 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007810
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007811 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007812 if (ret != 0) {
7813 goto exit;
7814 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007815 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007816 if (ret != 0) {
7817 goto exit;
7818 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007819
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007820 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007821 if (ret != 0) {
7822 goto exit;
7823 }
7824#endif /* MBEDTLS_USE_PSA_CRYPTO */
7825
7826 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7827
Jerry Yu615bd6f2022-02-17 14:25:15 +08007828 /*
7829 * TLSv1.2:
7830 * hash = PRF( master, finished_label,
7831 * Hash( handshake ) )[0.11]
7832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007834 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007837
Paul Elliottecb95be2023-08-11 16:41:04 +01007838 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007839
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007840 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007841
7842exit:
7843#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007844 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007845 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007846#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007847 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007848 return ret;
7849#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007850}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007851
7852#if defined(MBEDTLS_MD_CAN_SHA256)
7853static int ssl_calc_finished_tls_sha256(
7854 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7855{
7856 unsigned char padbuf[32];
7857 return ssl_calc_finished_tls_generic(ssl,
7858#if defined(MBEDTLS_USE_PSA_CRYPTO)
7859 &ssl->handshake->fin_sha256_psa,
7860#else
7861 &ssl->handshake->fin_sha256,
7862#endif
7863 padbuf, sizeof(padbuf),
7864 buf, from);
7865}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007866#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007867
Jerry Yub7ba49e2022-02-17 14:25:53 +08007868
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007869#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007870static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007872{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007873 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007874 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007875#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007876 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007877#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007878 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007879#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007880 padbuf, sizeof(padbuf),
7881 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007882}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007883#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007884
Gilles Peskine449bd832023-01-11 14:50:10 +01007885void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007886{
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007888
7889 /*
7890 * Free our handshake params
7891 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 mbedtls_ssl_handshake_free(ssl);
7893 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007894 ssl->handshake = NULL;
7895
7896 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007897 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007898 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 if (ssl->transform) {
7900 mbedtls_ssl_transform_free(ssl->transform);
7901 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007902 }
7903 ssl->transform = ssl->transform_negotiate;
7904 ssl->transform_negotiate = NULL;
7905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007907}
7908
Gilles Peskine449bd832023-01-11 14:50:10 +01007909void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007910{
7911 int resume = ssl->handshake->resume;
7912
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007914
7915#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007917 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7918 ssl->renego_records_seen = 0;
7919 }
7920#endif
7921
7922 /*
7923 * Free the previous session and switch in the current one
7924 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007926#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7927 /* RFC 7366 3.1: keep the EtM state */
7928 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007930#endif
7931
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 mbedtls_ssl_session_free(ssl->session);
7933 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934 }
7935 ssl->session = ssl->session_negotiate;
7936 ssl->session_negotiate = NULL;
7937
7938 /*
7939 * Add cache entry
7940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007942 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 resume == 0) {
7944 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7945 ssl->session->id,
7946 ssl->session->id_len,
7947 ssl->session) != 0) {
7948 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7949 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007950 }
7951
7952#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7954 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007955 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007957
7958 /* Keep last flight around in case we need to resend it:
7959 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7961 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007962#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007964
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007965 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007966
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007968}
7969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007972 int ret;
7973 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007976
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007978
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007979 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7980 if (ret != 0) {
7981 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7982 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007983
7984 /*
7985 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7986 * may define some other value. Currently (early 2016), no defined
7987 * ciphersuite does this (and this is unlikely to change as activity has
7988 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7989 */
7990 hash_len = 12;
7991
7992#if defined(MBEDTLS_SSL_RENEGOTIATION)
7993 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995#endif
7996
7997 ssl->out_msglen = 4 + hash_len;
7998 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7999 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8000
8001 /*
8002 * In case of session resuming, invert the client and server
8003 * ChangeCipherSpec messages order.
8004 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008006#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008008 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008010#endif
8011#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008013 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008015#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008017 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008019
8020 /*
8021 * Switch to our negotiated transform and session parameters for outbound
8022 * data.
8023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008025
8026#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008028 unsigned char i;
8029
8030 /* Remember current epoch settings for resending */
8031 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8033 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008034
8035 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008037
8038
8039 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 for (i = 2; i > 0; i--) {
8041 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008042 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 }
8044 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008045
8046 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (i == 0) {
8048 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8049 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008050 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008052#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008054
8055 ssl->transform_out = ssl->transform_negotiate;
8056 ssl->session_out = ssl->session_negotiate;
8057
8058#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8060 mbedtls_ssl_send_flight_completed(ssl);
8061 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008062#endif
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8066 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008067 }
8068
8069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8071 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8073 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008074 }
8075#endif
8076
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008078
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008080}
8081
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008082#define SSL_MAX_HASH_LEN 12
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008085{
8086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8087 unsigned int hash_len = 12;
8088 unsigned char buf[SSL_MAX_HASH_LEN];
8089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008091
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008092 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8093 if (ret != 0) {
8094 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8095 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008096
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8098 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008099 goto exit;
8100 }
8101
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8103 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8104 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8105 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008106 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8107 goto exit;
8108 }
8109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8111 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8112 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008113 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8114 goto exit;
8115 }
8116
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8118 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8119 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8120 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008121 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8122 goto exit;
8123 }
8124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8126 buf, hash_len) != 0) {
8127 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8128 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8129 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008130 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8131 goto exit;
8132 }
8133
8134#if defined(MBEDTLS_SSL_RENEGOTIATION)
8135 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008137#endif
8138
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008140#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008142 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008144#endif
8145#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008147 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008149#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008151 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008153
8154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8156 mbedtls_ssl_recv_flight_completed(ssl);
8157 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008158#endif
8159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008161
8162exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 mbedtls_platform_zeroize(buf, hash_len);
8164 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008165}
8166
Jerry Yu392112c2022-02-17 14:34:10 +08008167#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8168/*
8169 * Helper to get TLS 1.2 PRF from ciphersuite
8170 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008172static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008173{
Jerry Yu392112c2022-02-17 14:34:10 +08008174 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008176#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8178 return tls_prf_sha384;
8179 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008180#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008181#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008182 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8184 return tls_prf_sha256;
8185 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008186 }
8187#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008188#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8189 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008190 (void) ciphersuite_info;
8191#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008192
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008194}
8195#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008196
Gilles Peskine449bd832023-01-11 14:50:10 +01008197static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008198{
8199 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008200#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 if (tls_prf == tls_prf_sha384) {
8202 return MBEDTLS_SSL_TLS_PRF_SHA384;
8203 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008204#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008205#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 if (tls_prf == tls_prf_sha256) {
8207 return MBEDTLS_SSL_TLS_PRF_SHA256;
8208 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008209#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008211}
8212
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008213/*
8214 * Populate a transform structure with session keys and all the other
8215 * necessary information.
8216 *
8217 * Parameters:
8218 * - [in/out]: transform: structure to populate
8219 * [in] must be just initialised with mbedtls_ssl_transform_init()
8220 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8221 * - [in] ciphersuite
8222 * - [in] master
8223 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224 * - [in] tls_prf: pointer to PRF to use for key derivation
8225 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008226 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008227 * - [in] endpoint: client or server
8228 * - [in] ssl: used for:
8229 * - ssl->conf->{f,p}_export_keys
8230 * [in] optionally used for:
8231 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8232 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008233MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008234static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8235 int ciphersuite,
8236 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008237#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008239#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 ssl_tls_prf_t tls_prf,
8241 const unsigned char randbytes[64],
8242 mbedtls_ssl_protocol_version tls_version,
8243 unsigned endpoint,
8244 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245{
8246 int ret = 0;
8247 unsigned char keyblk[256];
8248 unsigned char *key1;
8249 unsigned char *key2;
8250 unsigned char *mac_enc;
8251 unsigned char *mac_dec;
8252 size_t mac_key_len = 0;
8253 size_t iv_copy_len;
8254 size_t keylen;
8255 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008256 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008257#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008258 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008259 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008260#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261
8262#if defined(MBEDTLS_USE_PSA_CRYPTO)
8263 psa_key_type_t key_type;
8264 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8265 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008266 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 size_t key_bits;
8268 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8269#endif
8270
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008271 /*
8272 * Some data just needs copying into the structure
8273 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008274#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008275 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008276#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008277 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008278
8279#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008281#endif
8282
8283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8286 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288 }
8289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8290
8291 /*
8292 * Get various info structures
8293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8295 if (ciphersuite_info == NULL) {
8296 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8297 ciphersuite));
8298 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008299 }
8300
Neil Armstrongab555e02022-04-04 11:07:59 +02008301 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008302#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008304#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008308 transform->taglen =
8309 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008311
8312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008313 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 transform->taglen,
8315 &alg,
8316 &key_type,
8317 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008318 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008320 goto end;
8321 }
8322#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008323 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 if (cipher_info == NULL) {
8325 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8326 ciphersuite_info->cipher));
8327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008329#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008330
Neil Armstronge4512952022-03-08 09:08:22 +01008331#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008332 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008334 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 (unsigned) ciphersuite_info->mac));
8336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008337 }
8338#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008339 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 if (md_info == NULL) {
8341 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8342 (unsigned) ciphersuite_info->mac));
8343 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008344 }
Neil Armstronge4512952022-03-08 09:08:22 +01008345#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008346
8347#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8348 /* Copy own and peer's CID if the use of the CID
8349 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8351 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008352
8353 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8355 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8356 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008357
8358 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8360 ssl->handshake->peer_cid_len);
8361 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8362 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363 }
8364#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8365
8366 /*
8367 * Compute key block using the PRF
8368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8370 if (ret != 0) {
8371 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8372 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008373 }
8374
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8376 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8377 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8378 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8379 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008380
8381 /*
8382 * Determine the appropriate key, IV and MAC length.
8383 */
8384
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008385#if defined(MBEDTLS_USE_PSA_CRYPTO)
8386 keylen = PSA_BITS_TO_BYTES(key_bits);
8387#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008389#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390
Valerio Settie5707042023-10-11 11:54:42 +02008391#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008393 size_t explicit_ivlen;
8394
8395 transform->maclen = 0;
8396 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008397
8398 /* All modes haves 96-bit IVs, but the length of the static parts vary
8399 * with mode and version:
8400 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8401 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8402 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8403 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8404 * sequence number).
8405 */
8406 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008407
8408 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008409#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008411#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8413 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008414#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008415
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008417 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008421
8422 /* Minimum length of encrypted record */
8423 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8424 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 } else
Valerio Settie5707042023-10-11 11:54:42 +02008426#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008429 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008431#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008432 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008433#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008434 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008435#endif /* MBEDTLS_USE_PSA_CRYPTO */
8436
8437#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008438 /* Get MAC length */
8439 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8440#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8443 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8444 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445 goto end;
8446 }
8447
8448 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008450#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008451 transform->maclen = mac_key_len;
8452
8453 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008454#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008456#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008457 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008458#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459
8460 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008464 /*
8465 * GenericBlockCipher:
8466 * 1. if EtM is in use: one block plus MAC
8467 * otherwise: * first multiple of blocklen greater than maclen
8468 * 2. IV
8469 */
8470#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 + block_size;
8474 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008475#endif
8476 {
8477 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 + block_size
8479 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 }
8481
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008483 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 } else {
8485 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008486 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8487 goto end;
8488 }
8489 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008491#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8492 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8494 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008495 }
8496
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8498 (unsigned) keylen,
8499 (unsigned) transform->minlen,
8500 (unsigned) transform->ivlen,
8501 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008502
8503 /*
8504 * Finally setup the cipher contexts, IVs and MAC secrets.
8505 */
8506#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008508 key1 = keyblk + mac_key_len * 2;
8509 key2 = keyblk + mac_key_len * 2 + keylen;
8510
8511 mac_enc = keyblk;
8512 mac_dec = keyblk + mac_key_len;
8513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 iv_copy_len = (transform->fixed_ivlen) ?
8515 transform->fixed_ivlen : transform->ivlen;
8516 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8517 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8518 iv_copy_len);
8519 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008520#endif /* MBEDTLS_SSL_CLI_C */
8521#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008523 key1 = keyblk + mac_key_len * 2 + keylen;
8524 key2 = keyblk + mac_key_len * 2;
8525
8526 mac_enc = keyblk + mac_key_len;
8527 mac_dec = keyblk;
8528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 iv_copy_len = (transform->fixed_ivlen) ?
8530 transform->fixed_ivlen : transform->ivlen;
8531 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8532 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8533 iv_copy_len);
8534 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535#endif /* MBEDTLS_SSL_SRV_C */
8536 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008538 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8539 goto end;
8540 }
8541
Paul Elliott4fb19552023-10-18 12:15:30 +01008542 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 ssl->f_export_keys(ssl->p_export_keys,
8544 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8545 master, 48,
8546 randbytes + 32,
8547 randbytes,
8548 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008549 }
8550
8551#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552 transform->psa_alg = alg;
8553
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8555 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8556 psa_set_key_algorithm(&attributes, alg);
8557 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008558
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 if ((status = psa_import_key(&attributes,
8560 key1,
8561 PSA_BITS_TO_BYTES(key_bits),
8562 &transform->psa_key_enc)) != PSA_SUCCESS) {
8563 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008564 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008566 goto end;
8567 }
8568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 if ((status = psa_import_key(&attributes,
8572 key2,
8573 PSA_BITS_TO_BYTES(key_bits),
8574 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008575 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008577 goto end;
8578 }
8579 }
8580#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8582 cipher_info)) != 0) {
8583 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008584 goto end;
8585 }
8586
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8588 cipher_info)) != 0) {
8589 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008590 goto end;
8591 }
8592
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8594 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8595 MBEDTLS_ENCRYPT)) != 0) {
8596 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008597 goto end;
8598 }
8599
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8601 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8602 MBEDTLS_DECRYPT)) != 0) {
8603 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008604 goto end;
8605 }
8606
8607#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8609 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8610 MBEDTLS_PADDING_NONE)) != 0) {
8611 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008612 goto end;
8613 }
8614
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8616 MBEDTLS_PADDING_NONE)) != 0) {
8617 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008618 goto end;
8619 }
8620 }
8621#endif /* MBEDTLS_CIPHER_MODE_CBC */
8622#endif /* MBEDTLS_USE_PSA_CRYPTO */
8623
Neil Armstrong29c0c042022-03-17 17:47:28 +01008624#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8625 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8626 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008628#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8632 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8633 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008634
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 if ((status = psa_import_key(&attributes,
8636 mac_enc, mac_key_len,
8637 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008638 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008640 goto end;
8641 }
8642
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8644 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008645#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008647#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008649 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8651 PSA_KEY_USAGE_VERIFY_HASH);
8652 } else {
8653 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8654 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 if ((status = psa_import_key(&attributes,
8657 mac_dec, mac_key_len,
8658 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008659 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008661 goto end;
8662 }
8663#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8665 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008666 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008667 }
8668 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8669 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008670 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008671 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008672#endif /* MBEDTLS_USE_PSA_CRYPTO */
8673 }
8674#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8675
8676 ((void) mac_dec);
8677 ((void) mac_enc);
8678
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008679end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8681 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008682}
8683
Valerio Settia08b1a42022-11-17 15:10:02 +01008684#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8685 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008686int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 psa_pake_operation_t *pake_ctx,
8688 const unsigned char *buf,
8689 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008690{
8691 psa_status_t status;
8692 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008693 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008694 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8695 * At round two perform a single cycle
8696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008698
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 for (; remaining_steps > 0; remaining_steps--) {
8700 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008701 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008703 /* Length is stored at the first byte */
8704 size_t length = buf[input_offset];
8705 input_offset += 1;
8706
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008708 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8709 }
8710
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 status = psa_pake_input(pake_ctx, step,
8712 buf + input_offset, length);
8713 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008714 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008715 }
8716
8717 input_offset += length;
8718 }
8719 }
8720
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008722 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008726}
8727
Valerio Setti6b3dab02022-11-17 17:14:54 +01008728int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 psa_pake_operation_t *pake_ctx,
8730 unsigned char *buf,
8731 size_t len, size_t *olen,
8732 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008733{
8734 psa_status_t status;
8735 size_t output_offset = 0;
8736 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008737 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008738 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8739 * At round two perform a single cycle
8740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008742
Gilles Peskine449bd832023-01-11 14:50:10 +01008743 for (; remaining_steps > 0; remaining_steps--) {
8744 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8745 step <= PSA_PAKE_STEP_ZK_PROOF;
8746 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008747 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008748 * For each step, prepend 1 byte with the length of the data as
8749 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 status = psa_pake_output(pake_ctx, step,
8752 buf + output_offset + 1,
8753 len - output_offset - 1,
8754 &output_len);
8755 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008756 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008757 }
8758
Valerio Setti99d88c12022-11-22 16:03:43 +01008759 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008760
8761 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008762 }
8763 }
8764
8765 *olen = output_offset;
8766
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008768}
Valerio Settia08b1a42022-11-17 15:10:02 +01008769#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8770
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008772int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8773 unsigned char *hash, size_t *hashlen,
8774 unsigned char *data, size_t data_len,
8775 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776{
8777 psa_status_t status;
8778 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008779 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008780
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008782
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if ((status = psa_hash_setup(&hash_operation,
8784 hash_alg)) != PSA_SUCCESS) {
8785 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786 goto exit;
8787 }
8788
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8790 64)) != PSA_SUCCESS) {
8791 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008792 goto exit;
8793 }
8794
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 if ((status = psa_hash_update(&hash_operation,
8796 data, data_len)) != PSA_SUCCESS) {
8797 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 goto exit;
8799 }
8800
Gilles Peskine449bd832023-01-11 14:50:10 +01008801 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8802 hashlen)) != PSA_SUCCESS) {
8803 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8804 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008805 }
8806
8807exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 if (status != PSA_SUCCESS) {
8809 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8810 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8811 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008812 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008814 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8815 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008817 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008819 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008821 }
8822 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008824}
8825
8826#else
8827
Gilles Peskine449bd832023-01-11 14:50:10 +01008828int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8829 unsigned char *hash, size_t *hashlen,
8830 unsigned char *data, size_t data_len,
8831 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008832{
8833 int ret = 0;
8834 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8836 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008837
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008839
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008841
8842 /*
8843 * digitally-signed struct {
8844 * opaque client_random[32];
8845 * opaque server_random[32];
8846 * ServerDHParams params;
8847 * };
8848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8850 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008851 goto exit;
8852 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8854 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008855 goto exit;
8856 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8858 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008859 goto exit;
8860 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8862 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008863 goto exit;
8864 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8866 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008867 goto exit;
8868 }
8869
8870exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008872
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 if (ret != 0) {
8874 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8875 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8876 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008877
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008879}
8880#endif /* MBEDTLS_USE_PSA_CRYPTO */
8881
Jerry Yud9d91da2022-02-17 14:57:06 +08008882#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8883
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008884/* Find the preferred hash for a given signature algorithm. */
8885unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 mbedtls_ssl_context *ssl,
8887 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008888{
Gabor Mezei078e8032022-04-27 21:17:56 +02008889 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008890 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008891
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8893 return MBEDTLS_SSL_HASH_NONE;
8894 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008895
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008897 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8899 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008900 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8902 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008903
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008904 mbedtls_md_type_t md_alg =
8905 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8906 if (md_alg == MBEDTLS_MD_NONE) {
8907 continue;
8908 }
8909
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008913 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008914 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008915
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8917 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8918 PSA_ALG_ECDSA(psa_hash_alg),
8919 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008920 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008922
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8924 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8925 PSA_ALG_RSA_PKCS1V15_SIGN(
8926 psa_hash_alg),
8927 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008928 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008930 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008931#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008932
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008934 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008935 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008936
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008938}
8939
8940#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8941
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942/* Serialization of TLS 1.2 sessions:
8943 *
8944 * struct {
8945 * uint64 start_time;
8946 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008947 * uint8 session_id_len; // at most 32
8948 * opaque session_id[32];
8949 * opaque master[48]; // fixed length in the standard
8950 * uint32 verify_result;
8951 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8952 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8953 * uint32 ticket_lifetime;
8954 * uint8 mfl_code; // up to 255 according to standard
8955 * uint8 encrypt_then_mac; // 0 or 1
8956 * } serialized_session_tls12;
8957 *
8958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008959static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8960 unsigned char *buf,
8961 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962{
8963 unsigned char *p = buf;
8964 size_t used = 0;
8965
8966#if defined(MBEDTLS_HAVE_TIME)
8967 uint64_t start;
8968#endif
8969#if defined(MBEDTLS_X509_CRT_PARSE_C)
8970#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8971 size_t cert_len;
8972#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8973#endif /* MBEDTLS_X509_CRT_PARSE_C */
8974
8975 /*
8976 * Time
8977 */
8978#if defined(MBEDTLS_HAVE_TIME)
8979 used += 8;
8980
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008982 start = (uint64_t) session->start;
8983
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985 p += 8;
8986 }
8987#endif /* MBEDTLS_HAVE_TIME */
8988
8989 /*
8990 * Basic mandatory fields
8991 */
8992 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 + 1 /* id_len */
8994 + sizeof(session->id)
8995 + sizeof(session->master)
8996 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008997
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 if (used <= buf_len) {
8999 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000 p += 2;
9001
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 *p++ = MBEDTLS_BYTE_0(session->id_len);
9003 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009004 p += 32;
9005
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007 p += 48;
9008
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010 p += 4;
9011 }
9012
9013 /*
9014 * Peer's end-entity certificate
9015 */
9016#if defined(MBEDTLS_X509_CRT_PARSE_C)
9017#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009019 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009021 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023
9024 used += 3 + cert_len;
9025
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 if (used <= buf_len) {
9027 *p++ = MBEDTLS_BYTE_2(cert_len);
9028 *p++ = MBEDTLS_BYTE_1(cert_len);
9029 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009030
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 if (session->peer_cert != NULL) {
9032 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009033 p += cert_len;
9034 }
9035 }
9036#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009038 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009039 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009040 *p++ = (unsigned char) session->peer_cert_digest_type;
9041 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 memcpy(p, session->peer_cert_digest,
9043 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 p += session->peer_cert_digest_len;
9045 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009047 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9050 *p++ = 0;
9051 }
9052 }
9053#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9054#endif /* MBEDTLS_X509_CRT_PARSE_C */
9055
9056 /*
9057 * Session ticket if any, plus associated data
9058 */
9059#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9060 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9061
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 if (used <= buf_len) {
9063 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9064 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9065 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009066
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 if (session->ticket != NULL) {
9068 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009069 p += session->ticket_len;
9070 }
9071
Gilles Peskine449bd832023-01-11 14:50:10 +01009072 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009073 p += 4;
9074 }
9075#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9076
9077 /*
9078 * Misc extension-related info
9079 */
9080#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9081 used += 1;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086#endif
9087
9088#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9089 used += 1;
9090
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 if (used <= buf_len) {
9092 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9093 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094#endif
9095
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009097}
9098
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009100static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9101 const unsigned char *buf,
9102 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103{
9104#if defined(MBEDTLS_HAVE_TIME)
9105 uint64_t start;
9106#endif
9107#if defined(MBEDTLS_X509_CRT_PARSE_C)
9108#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9109 size_t cert_len;
9110#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9111#endif /* MBEDTLS_X509_CRT_PARSE_C */
9112
9113 const unsigned char *p = buf;
9114 const unsigned char * const end = buf + len;
9115
9116 /*
9117 * Time
9118 */
9119#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 if (8 > (size_t) (end - p)) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009124 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009125 p += 8;
9126
9127 session->start = (time_t) start;
9128#endif /* MBEDTLS_HAVE_TIME */
9129
9130 /*
9131 * Basic mandatory fields
9132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9134 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9135 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009137 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009138 p += 2;
9139
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142 p += 32;
9143
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009145 p += 48;
9146
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009147 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148 p += 4;
9149
9150 /* Immediately clear invalid pointer values that have been read, in case
9151 * we exit early before we replaced them with valid ones. */
9152#if defined(MBEDTLS_X509_CRT_PARSE_C)
9153#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9154 session->peer_cert = NULL;
9155#else
9156 session->peer_cert_digest = NULL;
9157#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9158#endif /* MBEDTLS_X509_CRT_PARSE_C */
9159#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9160 session->ticket = NULL;
9161#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9162
9163 /*
9164 * Peer certificate
9165 */
9166#if defined(MBEDTLS_X509_CRT_PARSE_C)
9167#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9168 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if (3 > (size_t) (end - p)) {
9170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9171 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009173 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174 p += 3;
9175
Gilles Peskine449bd832023-01-11 14:50:10 +01009176 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if (cert_len > (size_t) (end - p)) {
9180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9181 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009182
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009184
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 if (session->peer_cert == NULL) {
9186 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9187 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009190
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9192 p, cert_len)) != 0) {
9193 mbedtls_x509_crt_free(session->peer_cert);
9194 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009195 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009197 }
9198
9199 p += cert_len;
9200 }
9201#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9202 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009203 if (2 > (size_t) (end - p)) {
9204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9205 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206
9207 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9208 session->peer_cert_digest_len = (size_t) *p++;
9209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009211 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9213 if (md_info == NULL) {
9214 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9215 }
9216 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9217 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9218 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9222 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009223
9224 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 mbedtls_calloc(1, session->peer_cert_digest_len);
9226 if (session->peer_cert_digest == NULL) {
9227 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9228 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009229
Gilles Peskine449bd832023-01-11 14:50:10 +01009230 memcpy(session->peer_cert_digest, p,
9231 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009232 p += session->peer_cert_digest_len;
9233 }
9234#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9235#endif /* MBEDTLS_X509_CRT_PARSE_C */
9236
9237 /*
9238 * Session ticket and associated data
9239 */
9240#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 if (3 > (size_t) (end - p)) {
9242 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9243 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009244
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009245 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009246 p += 3;
9247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 if (session->ticket_len != 0) {
9249 if (session->ticket_len > (size_t) (end - p)) {
9250 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9251 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009252
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 session->ticket = mbedtls_calloc(1, session->ticket_len);
9254 if (session->ticket == NULL) {
9255 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9256 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009257
Gilles Peskine449bd832023-01-11 14:50:10 +01009258 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009259 p += session->ticket_len;
9260 }
9261
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 if (4 > (size_t) (end - p)) {
9263 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9264 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009265
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009266 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009267 p += 4;
9268#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9269
9270 /*
9271 * Misc extension-related info
9272 */
9273#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 if (1 > (size_t) (end - p)) {
9275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9276 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009277
9278 session->mfl_code = *p++;
9279#endif
9280
9281#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 if (1 > (size_t) (end - p)) {
9283 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9284 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009285
9286 session->encrypt_then_mac = *p++;
9287#endif
9288
9289 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (p != end) {
9291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9292 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009295}
Jerry Yudc7bd172022-02-17 13:44:15 +08009296#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9297
XiaokangQian75d40ef2022-04-20 11:05:24 +00009298int mbedtls_ssl_validate_ciphersuite(
9299 const mbedtls_ssl_context *ssl,
9300 const mbedtls_ssl_ciphersuite_t *suite_info,
9301 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009303{
9304 (void) ssl;
9305
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 if (suite_info == NULL) {
9307 return -1;
9308 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009309
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 if ((suite_info->min_tls_version > max_tls_version) ||
9311 (suite_info->max_tls_version < min_tls_version)) {
9312 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009313 }
9314
XiaokangQian060d8672022-04-21 09:24:56 +00009315#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009316#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009317#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9319 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009320#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9322 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009323#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009324 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009326 }
9327#endif
9328
9329 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9330#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9332 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9333 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009334 }
9335#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9336#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9337
Gilles Peskine449bd832023-01-11 14:50:10 +01009338 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009339}
9340
Ronald Crone68ab4f2022-10-05 12:46:29 +02009341#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009342/*
9343 * Function for writing a signature algorithm extension.
9344 *
9345 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9346 * value (TLS 1.3 RFC8446):
9347 * enum {
9348 * ....
9349 * ecdsa_secp256r1_sha256( 0x0403 ),
9350 * ecdsa_secp384r1_sha384( 0x0503 ),
9351 * ecdsa_secp521r1_sha512( 0x0603 ),
9352 * ....
9353 * } SignatureScheme;
9354 *
9355 * struct {
9356 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9357 * } SignatureSchemeList;
9358 *
9359 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9360 * value (TLS 1.2 RFC5246):
9361 * enum {
9362 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9363 * sha512(6), (255)
9364 * } HashAlgorithm;
9365 *
9366 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9367 * SignatureAlgorithm;
9368 *
9369 * struct {
9370 * HashAlgorithm hash;
9371 * SignatureAlgorithm signature;
9372 * } SignatureAndHashAlgorithm;
9373 *
9374 * SignatureAndHashAlgorithm
9375 * supported_signature_algorithms<2..2^16-2>;
9376 *
9377 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9378 * generalization of the TLS 1.2 signature algorithm extension.
9379 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9380 * `SignatureScheme` field of TLS 1.3
9381 *
9382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009383int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9384 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009385{
9386 unsigned char *p = buf;
9387 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9388 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9389
9390 *out_len = 0;
9391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009393
9394 /* Check if we have space for header and length field:
9395 * - extension_type (2 bytes)
9396 * - extension_data_length (2 bytes)
9397 * - supported_signature_algorithms_length (2 bytes)
9398 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009400 p += 6;
9401
9402 /*
9403 * Write supported_signature_algorithms
9404 */
9405 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009406 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9407 if (sig_alg == NULL) {
9408 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9409 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009410
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9412 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9413 *sig_alg,
9414 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9415 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009416 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 }
9418 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9419 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009420 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9422 *sig_alg,
9423 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009424 }
9425
9426 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009427 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 if (supported_sig_alg_len == 0) {
9429 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9430 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009431 }
9432
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9434 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9435 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009436
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009437 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009438
9439#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009441#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009442
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009444}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009445#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009446
XiaokangQian40a35232022-05-07 09:02:40 +00009447#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009448/*
9449 * mbedtls_ssl_parse_server_name_ext
9450 *
9451 * Structure of server_name extension:
9452 *
9453 * enum {
9454 * host_name(0), (255)
9455 * } NameType;
9456 * opaque HostName<1..2^16-1>;
9457 *
9458 * struct {
9459 * NameType name_type;
9460 * select (name_type) {
9461 * case host_name: HostName;
9462 * } name;
9463 * } ServerName;
9464 * struct {
9465 * ServerName server_name_list<1..2^16-1>
9466 * } ServerNameList;
9467 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009468MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009469int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9470 const unsigned char *buf,
9471 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009472{
9473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9474 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009475 size_t server_name_list_len, hostname_len;
9476 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009477
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009479
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9481 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009482 p += 2;
9483
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009485 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 while (p < server_name_list_end) {
9487 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9488 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9489 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9490 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009491
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009493 /* sni_name is intended to be used only during the parsing of the
9494 * ClientHello message (it is reset to NULL before the end of
9495 * the message parsing). Thus it is ok to just point to the
9496 * reception buffer and not make a copy of it.
9497 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009498 ssl->handshake->sni_name = p + 3;
9499 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if (ssl->conf->f_sni == NULL) {
9501 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009502 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9504 ssl, p + 3, hostname_len);
9505 if (ret != 0) {
9506 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9507 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9508 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9509 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9510 }
9511 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009512 }
9513
9514 p += hostname_len + 3;
9515 }
9516
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009518}
9519#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9520
XiaokangQianacb39922022-06-17 10:18:48 +00009521#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009522MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009523int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9524 const unsigned char *buf,
9525 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009526{
9527 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009528 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009529 const unsigned char *protocol_name_list;
9530 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009531 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009532
9533 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009534 if (ssl->conf->alpn_list == NULL) {
9535 return 0;
9536 }
XiaokangQianacb39922022-06-17 10:18:48 +00009537
9538 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009539 * RFC7301, section 3.1
9540 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009541 *
XiaokangQianc7403452022-06-23 03:24:12 +00009542 * struct {
9543 * ProtocolName protocol_name_list<2..2^16-1>
9544 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009545 */
9546
XiaokangQianc7403452022-06-23 03:24:12 +00009547 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009548 * protocol_name_list_len 2 bytes
9549 * protocol_name_len 1 bytes
9550 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009553
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009555 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009557 protocol_name_list = p;
9558 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009559
9560 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009562 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9564 protocol_name_len);
9565 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009566 MBEDTLS_SSL_PEND_FATAL_ALERT(
9567 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009568 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9569 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009570 }
9571
9572 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009573 }
9574
9575 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9577 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009578 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009579 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009580 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009581 if (protocol_name_len == alpn_len &&
9582 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009583 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009585 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009586
9587 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009588 }
9589 }
9590
XiaokangQian95d5f542022-06-24 02:29:26 +00009591 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009592 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9594 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9595 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009596}
9597
Gilles Peskine449bd832023-01-11 14:50:10 +01009598int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9599 unsigned char *buf,
9600 unsigned char *end,
9601 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009602{
9603 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009604 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009605 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009606
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 if (ssl->alpn_chosen == NULL) {
9608 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009609 }
9610
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 protocol_name_len = strlen(ssl->alpn_chosen);
9612 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009613
Gilles Peskine449bd832023-01-11 14:50:10 +01009614 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009615 /*
9616 * 0 . 1 ext identifier
9617 * 2 . 3 ext length
9618 * 4 . 5 protocol list length
9619 * 6 . 6 protocol name length
9620 * 7 . 7+n protocol name
9621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009622 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009623
XiaokangQian95d5f542022-06-24 02:29:26 +00009624 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009625
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9627 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009628 /* Note: the length of the chosen protocol has been checked to be less
9629 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009631 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009632
Gilles Peskine449bd832023-01-11 14:50:10 +01009633 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009634
9635#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009636 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009637#endif
9638
Gilles Peskine449bd832023-01-11 14:50:10 +01009639 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009640}
9641#endif /* MBEDTLS_SSL_ALPN */
9642
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009643#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009644 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009645 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009646 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009647int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9648 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009649{
9650 /* Initialize to suppress unnecessary compiler warning */
9651 size_t hostname_len = 0;
9652
9653 /* Check if new hostname is valid before
9654 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009655 if (hostname != NULL) {
9656 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009657
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9660 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009661 }
9662
9663 /* Now it's clear that we will overwrite the old hostname,
9664 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009666 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009668 }
9669
9670 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009672 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 } else {
9674 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9675 if (session->hostname == NULL) {
9676 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9677 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009678
Gilles Peskine449bd832023-01-11 14:50:10 +01009679 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009680 }
9681
Gilles Peskine449bd832023-01-11 14:50:10 +01009682 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009683}
Xiaokang Qian03409292022-10-12 02:49:52 +00009684#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9685 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009686 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009687 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009689#endif /* MBEDTLS_SSL_TLS_C */