blob: 0071b06aa7b162cde3de8182e3e96799f18e948b [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;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001543 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001546
1547 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548#if defined(MBEDTLS_SSL_RENEGOTIATION)
1549 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001550 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001551
1552 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1554 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001555#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001557
Hanno Beckerb0302c42021-08-03 09:39:42 +01001558 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001559 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 if (ssl->session) {
1561 mbedtls_ssl_session_free(ssl->session);
1562 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001563 ssl->session = NULL;
1564 }
1565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001567 ssl->alpn_chosen = NULL;
1568#endif
1569
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001570#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001571 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001574#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 if (free_cli_id) {
1576 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001577 ssl->cli_id = NULL;
1578 ssl->cli_id_len = 0;
1579 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001580#endif
1581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 if ((ret = ssl_handshake_init(ssl)) != 0) {
1583 return ret;
1584 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001587}
1588
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001589/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001590 * Reset an initialized and used SSL context for re-use while retaining
1591 * all application-set variables, function pointers and data.
1592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001593int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594{
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001596}
1597
1598/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001599 * SSL set accessors
1600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001601void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001602{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001603 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001604}
1605
Gilles Peskine449bd832023-01-11 14:50:10 +01001606void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001608 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001609}
1610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001611#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001612void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001614 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001615}
1616#endif
1617
Gilles Peskine449bd832023-01-11 14:50:10 +01001618void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001620 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001621}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1626 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001627{
1628 ssl->disable_datagram_packing = !allow_packing;
1629}
1630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1632 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->hs_timeout_min = min;
1635 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001636}
1637#endif
1638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001640{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001641 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001642}
1643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001645void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1646 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1647 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001648{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001649 conf->f_vrfy = f_vrfy;
1650 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1655 int (*f_rng)(void *, unsigned char *, size_t),
1656 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001657{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001658 conf->f_rng = f_rng;
1659 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001660}
1661
Gilles Peskine449bd832023-01-11 14:50:10 +01001662void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1663 void (*f_dbg)(void *, int, const char *, int, const char *),
1664 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001665{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001666 conf->f_dbg = f_dbg;
1667 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1671 void *p_bio,
1672 mbedtls_ssl_send_t *f_send,
1673 mbedtls_ssl_recv_t *f_recv,
1674 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001675{
1676 ssl->p_bio = p_bio;
1677 ssl->f_send = f_send;
1678 ssl->f_recv = f_recv;
1679 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001680}
1681
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001683void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001684{
1685 ssl->mtu = mtu;
1686}
1687#endif
1688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690{
1691 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001692}
1693
Gilles Peskine449bd832023-01-11 14:50:10 +01001694void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1695 void *p_timer,
1696 mbedtls_ssl_set_timer_t *f_set_timer,
1697 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001698{
1699 ssl->p_timer = p_timer;
1700 ssl->f_set_timer = f_set_timer;
1701 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001702
1703 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001705}
1706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1709 void *p_cache,
1710 mbedtls_ssl_cache_get_t *f_get_cache,
1711 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001712{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001713 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001714 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001715 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001716}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001720int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001721{
Janos Follath865b3eb2019-12-16 11:46:15 +00001722 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001725 session == NULL ||
1726 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001729 }
1730
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 if (ssl->handshake->resume == 1) {
1732 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1733 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001734
Jerry Yu21092062022-10-10 21:21:31 +08001735#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001737 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001741 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1743 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1744 session->ciphersuite));
1745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001746 }
Jerry Yu40afab62022-10-08 10:42:13 +08001747 }
Jerry Yu21092062022-10-10 21:21:31 +08001748#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1751 session)) != 0) {
1752 return ret;
1753 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Paul Bakker0a597072012-09-25 21:55:46 +00001755 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001758}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1762 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001763{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001764 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001765}
1766
Ronald Cron6f135e12021-12-08 16:57:54 +01001767#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001768void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1769 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001771 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001772}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001773
1774#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001775void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1776 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001777{
1778 conf->early_data_enabled = early_data_enabled;
1779}
Jerry Yucc4e0072022-11-22 17:22:22 +08001780
1781#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001782void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001784{
Jerry Yu39da9852022-12-06 16:58:36 +08001785 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001786}
1787#endif /* MBEDTLS_SSL_SRV_C */
1788
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001789#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001790#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001793void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1794 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001795{
1796 conf->cert_profile = profile;
1797}
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001800{
1801 mbedtls_ssl_key_cert *cur = key_cert, *next;
1802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001806 cur = next;
1807 }
1808}
1809
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001810/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001811MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001812static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1813 mbedtls_x509_crt *cert,
1814 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815{
niisato8ee24222018-06-25 19:05:48 +09001816 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001823 }
1824
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1826 if (new_cert == NULL) {
1827 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1828 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829
niisato8ee24222018-06-25 19:05:48 +09001830 new_cert->cert = cert;
1831 new_cert->key = key;
1832 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001833
Glenn Strauss36872db2022-01-22 05:06:31 -05001834 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001836 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001840 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 }
niisato8ee24222018-06-25 19:05:48 +09001842 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843 }
1844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001846}
1847
Gilles Peskine449bd832023-01-11 14:50:10 +01001848int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001851{
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853}
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001856 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001858{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001859 conf->ca_chain = ca_chain;
1860 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001861
1862#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1863 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1864 * cannot be used together. */
1865 conf->f_ca_cb = NULL;
1866 conf->p_ca_cb = NULL;
1867#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001868}
Hanno Becker5adaad92019-03-27 16:54:37 +00001869
1870#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001871void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1872 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1873 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001874{
1875 conf->f_ca_cb = f_ca_cb;
1876 conf->p_ca_cb = p_ca_cb;
1877
1878 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1879 * cannot be used together. */
1880 conf->ca_chain = NULL;
1881 conf->ca_crl = NULL;
1882}
1883#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001885
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001886#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001887const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1888 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001889{
1890 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001892}
1893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1895 mbedtls_x509_crt *own_cert,
1896 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001897{
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1899 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001900}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1903 mbedtls_x509_crt *ca_chain,
1904 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001905{
1906 ssl->handshake->sni_ca_chain = ca_chain;
1907 ssl->handshake->sni_ca_crl = ca_crl;
1908}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001909
Glenn Strauss999ef702022-03-11 01:37:23 -05001910#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1912 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001913{
1914 ssl->handshake->dn_hints = crt;
1915}
1916#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1919 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001920{
1921 ssl->handshake->sni_authmode = authmode;
1922}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001923#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1924
Hanno Becker8927c832019-04-03 12:52:50 +01001925#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001926void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1927 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1928 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001929{
1930 ssl->f_vrfy = f_vrfy;
1931 ssl->p_vrfy = p_vrfy;
1932}
1933#endif
1934
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001935#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001936
Valerio Setti016f6822022-12-09 14:17:50 +01001937#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001938static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1939static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1940
Valerio Setti016f6822022-12-09 14:17:50 +01001941static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 mbedtls_ssl_context *ssl,
1943 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001944{
1945 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001946 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001949 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001950 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1952 psa_pake_cs_set_primitive(&cipher_suite,
1953 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1954 PSA_ECC_FAMILY_SECP_R1,
1955 256));
1956 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1959 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001960 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001964 user = jpake_server_id;
1965 user_len = sizeof(jpake_server_id);
1966 peer = jpake_client_id;
1967 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001969 user = jpake_client_id;
1970 user_len = sizeof(jpake_client_id);
1971 peer = jpake_server_id;
1972 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001974
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001975 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1976 if (status != PSA_SUCCESS) {
1977 return status;
1978 }
1979
1980 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001982 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Valerio Setti016f6822022-12-09 14:17:50 +01001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1986 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001987 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 }
Valerio Setti016f6822022-12-09 14:17:50 +01001989
1990 ssl->handshake->psa_pake_ctx_is_ok = 1;
1991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001993}
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1996 const unsigned char *pw,
1997 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001998{
1999 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2000 psa_status_t status;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (ssl->handshake == NULL || ssl->conf == NULL) {
2003 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002004 }
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 /* Empty password is not valid */
2007 if ((pw == NULL) || (pw_len == 0)) {
2008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2009 }
2010
2011 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2012 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2013 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2014
2015 status = psa_import_key(&attributes, pw, pw_len,
2016 &ssl->handshake->psa_pake_password);
2017 if (status != PSA_SUCCESS) {
2018 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2019 }
2020
2021 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2022 ssl->handshake->psa_pake_password);
2023 if (status != PSA_SUCCESS) {
2024 psa_destroy_key(ssl->handshake->psa_pake_password);
2025 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2026 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2027 }
2028
2029 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002030}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2033 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002034{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002035 psa_status_t status;
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake == NULL || ssl->conf == NULL) {
2038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 if (mbedtls_svc_key_id_is_null(pwd)) {
2042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2043 }
2044
2045 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2046 if (status != PSA_SUCCESS) {
2047 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2048 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2049 }
2050
2051 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002052}
2053#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002054int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2055 const unsigned char *pw,
2056 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002057{
2058 mbedtls_ecjpake_role role;
2059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (ssl->handshake == NULL || ssl->conf == NULL) {
2061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2062 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002063
Valerio Settic689ed82022-12-07 14:40:38 +01002064 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if ((pw == NULL) || (pw_len == 0)) {
2066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2067 }
Valerio Settic689ed82022-12-07 14:40:38 +01002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2076 role,
2077 MBEDTLS_MD_SHA256,
2078 MBEDTLS_ECP_DP_SECP256R1,
2079 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080}
Valerio Setti02c25b52022-11-15 14:08:42 +01002081#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002082#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083
Ronald Cron73fe8df2022-10-05 14:31:43 +02002084#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002085int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002086{
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (conf->psk_identity == NULL ||
2088 conf->psk_identity_len == 0) {
2089 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002090 }
2091
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002092#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2094 return 1;
2095 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (conf->psk != NULL && conf->psk_len != 0) {
2099 return 1;
2100 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002103}
2104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002106{
2107 /* Remove reference to existing PSK, if any. */
2108#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002110 /* The maintenance of the PSK key slot is the
2111 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002112 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002113 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002116 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117 conf->psk = NULL;
2118 conf->psk_len = 0;
2119 }
2120
2121 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk_identity != NULL) {
2123 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 conf->psk_identity = NULL;
2125 conf->psk_identity_len = 0;
2126 }
2127}
2128
Hanno Becker7390c712018-11-15 13:33:04 +00002129/* This function assumes that PSK identity in the SSL config is unset.
2130 * It checks that the provided identity is well-formed and attempts
2131 * to make a copy of it in the SSL config.
2132 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002133MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002134static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2135 unsigned char const *psk_identity,
2136 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002137{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002138 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002140 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 (psk_identity_len >> 16) != 0 ||
2142 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002144 }
2145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2147 if (conf->psk_identity == NULL) {
2148 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2149 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002150
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002151 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002155}
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2158 const unsigned char *psk, size_t psk_len,
2159 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002160{
Janos Follath865b3eb2019-12-16 11:46:15 +00002161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002162
2163 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2165 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2166 }
Hanno Becker7390c712018-11-15 13:33:04 +00002167
2168 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (psk == NULL) {
2170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2171 }
2172 if (psk_len == 0) {
2173 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2174 }
2175 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2176 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2177 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2180 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2181 }
Hanno Becker7390c712018-11-15 13:33:04 +00002182 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002184
2185 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2187 if (ret != 0) {
2188 ssl_conf_remove_psk(conf);
2189 }
Hanno Becker7390c712018-11-15 13:33:04 +00002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002192}
2193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002195{
2196#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002198 /* The maintenance of the external PSK key slot is the
2199 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (ssl->handshake->psk_opaque_is_internal) {
2201 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002202 ssl->handshake->psk_opaque_is_internal = 0;
2203 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002204 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205 }
Neil Armstronge952a302022-05-03 10:22:14 +02002206#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002208 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002210 ssl->handshake->psk_len = 0;
2211 }
Neil Armstronge952a302022-05-03 10:22:14 +02002212#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002213}
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2216 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002217{
Neil Armstrong501c9322022-05-03 09:35:09 +02002218#if defined(MBEDTLS_USE_PSA_CRYPTO)
2219 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002221 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002222 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002223#endif /* MBEDTLS_USE_PSA_CRYPTO */
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 if (psk == NULL || ssl->handshake == NULL) {
2226 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2227 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2231 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002234
Neil Armstrong501c9322022-05-03 09:35:09 +02002235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002236#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2238 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2240 } else {
2241 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2242 }
2243 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002244 }
2245#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002246
Jerry Yu568ec252022-07-22 21:27:34 +08002247#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2249 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2250 psa_set_key_usage_flags(&key_attributes,
2251 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002252 }
2253#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 psa_set_key_algorithm(&key_attributes, alg);
2256 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2259 if (status != PSA_SUCCESS) {
2260 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2261 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002262
2263 /* Allow calling psa_destroy_key() on psk remove */
2264 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002266#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2268 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2269 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002270
2271 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002275#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002276}
2277
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002278#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002279int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2280 mbedtls_svc_key_id_t psk,
2281 const unsigned char *psk_identity,
2282 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002283{
Janos Follath865b3eb2019-12-16 11:46:15 +00002284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002285
2286 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2288 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2289 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002290
Hanno Becker7390c712018-11-15 13:33:04 +00002291 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if (mbedtls_svc_key_id_is_null(psk)) {
2293 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2294 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002295 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002296
2297 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2299 psk_identity_len);
2300 if (ret != 0) {
2301 ssl_conf_remove_psk(conf);
2302 }
Hanno Becker7390c712018-11-15 13:33:04 +00002303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002305}
2306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2308 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002309{
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if ((mbedtls_svc_key_id_is_null(psk)) ||
2311 (ssl->handshake == NULL)) {
2312 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2313 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002318}
2319#endif /* MBEDTLS_USE_PSA_CRYPTO */
2320
Jerry Yu8897c072022-08-12 13:56:53 +08002321#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002322void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2323 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2324 size_t),
2325 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326{
2327 conf->f_psk = f_psk;
2328 conf->p_psk = p_psk;
2329}
Jerry Yu8897c072022-08-12 13:56:53 +08002330#endif /* MBEDTLS_SSL_SRV_C */
2331
Ronald Cron73fe8df2022-10-05 14:31:43 +02002332#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002333
2334#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002335static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002337{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002338#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 if (alg == PSA_ALG_CBC_NO_PADDING) {
2340 return MBEDTLS_SSL_MODE_CBC;
2341 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002342#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (PSA_ALG_IS_AEAD(alg)) {
2344 return MBEDTLS_SSL_MODE_AEAD;
2345 }
2346 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002347}
2348
2349#else /* MBEDTLS_USE_PSA_CRYPTO */
2350
2351static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002353{
2354#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (mode == MBEDTLS_MODE_CBC) {
2356 return MBEDTLS_SSL_MODE_CBC;
2357 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002358#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2359
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002360#if defined(MBEDTLS_GCM_C) || \
2361 defined(MBEDTLS_CCM_C) || \
2362 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002364 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mode == MBEDTLS_MODE_CHACHAPOLY) {
2366 return MBEDTLS_SSL_MODE_AEAD;
2367 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371}
Gilles Peskine301711e2022-04-26 16:57:05 +02002372#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373
Gilles Peskinee108d982022-04-26 16:50:40 +02002374static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2375 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002377{
2378#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2380 base_mode == MBEDTLS_SSL_MODE_CBC) {
2381 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002382 }
2383#else
2384 (void) encrypt_then_mac;
2385#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002387}
2388
Neil Armstrongab555e02022-04-04 11:07:59 +02002389mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391{
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002395#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002397#endif
2398 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002399
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002401#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 encrypt_then_mac = transform->encrypt_then_mac;
2403#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405}
2406
Neil Armstrongab555e02022-04-04 11:07:59 +02002407mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002410#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412{
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2414
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415#if defined(MBEDTLS_USE_PSA_CRYPTO)
2416 psa_status_t status;
2417 psa_algorithm_t alg;
2418 psa_key_type_t type;
2419 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002420 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2421 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (status == PSA_SUCCESS) {
2423 base_mode = mbedtls_ssl_get_base_mode(alg);
2424 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#else
2426 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002427 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002429 base_mode =
2430 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002432 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002433#endif /* MBEDTLS_USE_PSA_CRYPTO */
2434
Gilles Peskinee108d982022-04-26 16:50:40 +02002435#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2436 int encrypt_then_mac = 0;
2437#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002439}
2440
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002441#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002442
2443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002444/* Serialization of TLS 1.3 sessions:
2445 *
2446 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002447 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002448 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002450 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002451 * } ClientOnlyData;
2452 *
2453 * struct {
2454 * uint8 endpoint;
2455 * uint8 ciphersuite[2];
2456 * uint32 ticket_age_add;
2457 * uint8 ticket_flags;
2458 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002459 * uint32 max_early_data_size;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002460 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * select ( endpoint ) {
2462 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002463 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002464 * };
2465 * } serialized_session_tls13;
2466 *
2467 */
2468#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002470static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2471 unsigned char *buf,
2472 size_t buf_len,
2473 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002474{
2475 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002476#if defined(MBEDTLS_SSL_CLI_C) && \
2477 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 size_t hostname_len = (session->hostname == NULL) ?
2479 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002480#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002481 size_t needed = 1 /* endpoint */
2482 + 2 /* ciphersuite */
2483 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002484 + 1 /* ticket_flags */
2485 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002486 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2489 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2490 }
Jerry Yu34191072022-08-18 10:32:09 +08002491 needed += session->resumption_key_len; /* resumption_key */
2492
Jerry Yu02e3a072022-12-12 15:13:20 +08002493#if defined(MBEDTLS_SSL_EARLY_DATA)
2494 needed += 4; /* max_early_data_size */
2495#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002496#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002497 needed += 2; /* record_size_limit */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002498#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002499
Jerry Yu438ddd82022-07-07 06:55:50 +00002500#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002501 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002502#endif
2503
2504#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002506#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002507 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002509#endif
2510
Jerry Yu438ddd82022-07-07 06:55:50 +00002511 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002512 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002513
2514 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 if (session->ticket_len > SIZE_MAX - needed) {
2516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2517 }
Jerry Yu34191072022-08-18 10:32:09 +08002518
Jerry Yue28d9742022-08-18 15:44:03 +08002519 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002520 }
2521#endif /* MBEDTLS_SSL_CLI_C */
2522
Jerry Yue36fdd62022-08-17 21:31:36 +08002523 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (needed > buf_len) {
2525 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2526 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002527
2528 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2530 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 p[7] = session->ticket_flags;
2532
2533 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002534 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002535 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002537 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002538
Jerry Yu02e3a072022-12-12 15:13:20 +08002539#if defined(MBEDTLS_SSL_EARLY_DATA)
2540 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2541 p += 4;
2542#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002543#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2544 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2545 p += 2;
2546#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002547
Jerry Yu438ddd82022-07-07 06:55:50 +00002548#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002550 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002551 p += 8;
2552 }
2553#endif /* MBEDTLS_HAVE_TIME */
2554
2555#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002557#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002563 p += hostname_len;
2564 }
2565#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2566
Jerry Yu438ddd82022-07-07 06:55:50 +00002567#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002568 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += 8;
2570#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002572 p += 4;
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002575 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (session->ticket != NULL && session->ticket_len > 0) {
2578 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002579 p += session->ticket_len;
2580 }
2581 }
2582#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002584}
2585
2586MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002587static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2588 const unsigned char *buf,
2589 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002590{
2591 const unsigned char *p = buf;
2592 const unsigned char *end = buf + len;
2593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (end - p < 9) {
2595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2596 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002597 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2599 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002600 session->ticket_flags = p[7];
2601
2602 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002603 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002604 p += 9;
2605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 if (end - p < session->resumption_key_len) {
2607 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2608 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2612 }
2613 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002614 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002615
Jerry Yu02e3a072022-12-12 15:13:20 +08002616#if defined(MBEDTLS_SSL_EARLY_DATA)
2617 if (end - p < 4) {
2618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2619 }
2620 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2621 p += 4;
2622#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002623#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2624 if (end - p < 2) {
2625 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2626 }
2627 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
2628 p += 2;
2629#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002630
Jerry Yu438ddd82022-07-07 06:55:50 +00002631#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2633 if (end - p < 8) {
2634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2635 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002636 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002637 p += 8;
2638 }
2639#endif /* MBEDTLS_HAVE_TIME */
2640
2641#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002643#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002644 size_t hostname_len;
2645 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (end - p < 2) {
2647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2648 }
2649 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002650 p += 2;
2651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (end - p < (long int) hostname_len) {
2653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2654 }
2655 if (hostname_len > 0) {
2656 session->hostname = mbedtls_calloc(1, hostname_len);
2657 if (session->hostname == NULL) {
2658 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2659 }
2660 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002661 p += hostname_len;
2662 }
Yanray Wangfd256542023-11-22 10:32:03 +08002663#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002664
Jerry Yu438ddd82022-07-07 06:55:50 +00002665#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (end - p < 8) {
2667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2668 }
Jerry Yu342a5552023-11-10 14:23:39 +08002669 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002670 p += 8;
2671#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (end - p < 4) {
2673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2674 }
2675 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002676 p += 4;
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if (end - p < 2) {
2679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2680 }
2681 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002682 p += 2;
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if (end - p < (long int) session->ticket_len) {
2685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2686 }
2687 if (session->ticket_len > 0) {
2688 session->ticket = mbedtls_calloc(1, session->ticket_len);
2689 if (session->ticket == NULL) {
2690 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2691 }
2692 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002693 p += session->ticket_len;
2694 }
2695 }
2696#endif /* MBEDTLS_SSL_CLI_C */
2697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002699
2700}
2701#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002702MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002703static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2704 unsigned char *buf,
2705 size_t buf_len,
2706 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002707{
2708 ((void) session);
2709 ((void) buf);
2710 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002711 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002713}
Jerry Yu438ddd82022-07-07 06:55:50 +00002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2716 unsigned char *buf,
2717 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002718{
2719 ((void) session);
2720 ((void) buf);
2721 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002723}
2724#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002725#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2728 size_t taglen,
2729 psa_algorithm_t *alg,
2730 psa_key_type_t *key_type,
2731 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002732{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002733#if !defined(MBEDTLS_SSL_HAVE_CCM)
2734 (void) taglen;
2735#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002737#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002738 case MBEDTLS_CIPHER_AES_128_CBC:
2739 *alg = PSA_ALG_CBC_NO_PADDING;
2740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 128;
2742 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002743#endif
2744#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002747 *key_type = PSA_KEY_TYPE_AES;
2748 *key_size = 128;
2749 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002750#endif
2751#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002752 case MBEDTLS_CIPHER_AES_128_GCM:
2753 *alg = PSA_ALG_GCM;
2754 *key_type = PSA_KEY_TYPE_AES;
2755 *key_size = 128;
2756 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002757#endif
2758#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002759 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002761 *key_type = PSA_KEY_TYPE_AES;
2762 *key_size = 192;
2763 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002764#endif
2765#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002766 case MBEDTLS_CIPHER_AES_192_GCM:
2767 *alg = PSA_ALG_GCM;
2768 *key_type = PSA_KEY_TYPE_AES;
2769 *key_size = 192;
2770 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002771#endif
2772#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002773 case MBEDTLS_CIPHER_AES_256_CBC:
2774 *alg = PSA_ALG_CBC_NO_PADDING;
2775 *key_type = PSA_KEY_TYPE_AES;
2776 *key_size = 256;
2777 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002778#endif
2779#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002782 *key_type = PSA_KEY_TYPE_AES;
2783 *key_size = 256;
2784 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002785#endif
2786#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002787 case MBEDTLS_CIPHER_AES_256_GCM:
2788 *alg = PSA_ALG_GCM;
2789 *key_type = PSA_KEY_TYPE_AES;
2790 *key_size = 256;
2791 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002792#endif
2793#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002794 case MBEDTLS_CIPHER_ARIA_128_CBC:
2795 *alg = PSA_ALG_CBC_NO_PADDING;
2796 *key_type = PSA_KEY_TYPE_ARIA;
2797 *key_size = 128;
2798 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002799#endif
2800#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002801 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 *key_type = PSA_KEY_TYPE_ARIA;
2804 *key_size = 128;
2805 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002806#endif
2807#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002808 case MBEDTLS_CIPHER_ARIA_128_GCM:
2809 *alg = PSA_ALG_GCM;
2810 *key_type = PSA_KEY_TYPE_ARIA;
2811 *key_size = 128;
2812 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002813#endif
2814#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002815 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002817 *key_type = PSA_KEY_TYPE_ARIA;
2818 *key_size = 192;
2819 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002820#endif
2821#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002822 case MBEDTLS_CIPHER_ARIA_192_GCM:
2823 *alg = PSA_ALG_GCM;
2824 *key_type = PSA_KEY_TYPE_ARIA;
2825 *key_size = 192;
2826 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002827#endif
2828#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002829 case MBEDTLS_CIPHER_ARIA_256_CBC:
2830 *alg = PSA_ALG_CBC_NO_PADDING;
2831 *key_type = PSA_KEY_TYPE_ARIA;
2832 *key_size = 256;
2833 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002834#endif
2835#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002836 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002838 *key_type = PSA_KEY_TYPE_ARIA;
2839 *key_size = 256;
2840 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002841#endif
2842#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002843 case MBEDTLS_CIPHER_ARIA_256_GCM:
2844 *alg = PSA_ALG_GCM;
2845 *key_type = PSA_KEY_TYPE_ARIA;
2846 *key_size = 256;
2847 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002848#endif
2849#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002850 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2851 *alg = PSA_ALG_CBC_NO_PADDING;
2852 *key_type = PSA_KEY_TYPE_CAMELLIA;
2853 *key_size = 128;
2854 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002855#endif
2856#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002857 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002859 *key_type = PSA_KEY_TYPE_CAMELLIA;
2860 *key_size = 128;
2861 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002862#endif
2863#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002864 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2865 *alg = PSA_ALG_GCM;
2866 *key_type = PSA_KEY_TYPE_CAMELLIA;
2867 *key_size = 128;
2868 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002869#endif
2870#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002871 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002873 *key_type = PSA_KEY_TYPE_CAMELLIA;
2874 *key_size = 192;
2875 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002876#endif
2877#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002878 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2879 *alg = PSA_ALG_GCM;
2880 *key_type = PSA_KEY_TYPE_CAMELLIA;
2881 *key_size = 192;
2882 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002883#endif
2884#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002885 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2886 *alg = PSA_ALG_CBC_NO_PADDING;
2887 *key_type = PSA_KEY_TYPE_CAMELLIA;
2888 *key_size = 256;
2889 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002890#endif
2891#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002892 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002894 *key_type = PSA_KEY_TYPE_CAMELLIA;
2895 *key_size = 256;
2896 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002897#endif
2898#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002899 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2900 *alg = PSA_ALG_GCM;
2901 *key_type = PSA_KEY_TYPE_CAMELLIA;
2902 *key_size = 256;
2903 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002904#endif
2905#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002906 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2907 *alg = PSA_ALG_CHACHA20_POLY1305;
2908 *key_type = PSA_KEY_TYPE_CHACHA20;
2909 *key_size = 256;
2910 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002911#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002912 case MBEDTLS_CIPHER_NULL:
2913 *alg = MBEDTLS_SSL_NULL_CIPHER;
2914 *key_type = 0;
2915 *key_size = 0;
2916 break;
2917 default:
2918 return PSA_ERROR_NOT_SUPPORTED;
2919 }
2920
2921 return PSA_SUCCESS;
2922}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002923#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002924
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002925#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002926int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2927 const unsigned char *dhm_P, size_t P_len,
2928 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002929{
Janos Follath865b3eb2019-12-16 11:46:15 +00002930 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 mbedtls_mpi_free(&conf->dhm_P);
2933 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2936 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2937 mbedtls_mpi_free(&conf->dhm_P);
2938 mbedtls_mpi_free(&conf->dhm_G);
2939 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002940 }
2941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002943}
Paul Bakker5121ce52009-01-03 21:22:43 +00002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002946{
Janos Follath865b3eb2019-12-16 11:46:15 +00002947 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 mbedtls_mpi_free(&conf->dhm_P);
2950 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2953 &conf->dhm_P)) != 0 ||
2954 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2955 &conf->dhm_G)) != 0) {
2956 mbedtls_mpi_free(&conf->dhm_P);
2957 mbedtls_mpi_free(&conf->dhm_G);
2958 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002959 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002962}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002963#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002964
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002965#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2966/*
2967 * Set the minimum length for Diffie-Hellman parameters
2968 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002969void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2970 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002971{
2972 conf->dhm_min_bitlen = bitlen;
2973}
2974#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2975
Ronald Crone68ab4f2022-10-05 12:46:29 +02002976#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002977#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002978/*
2979 * Set allowed/preferred hashes for handshake signatures
2980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002981void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2982 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002983{
2984 conf->sig_hashes = hashes;
2985}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002986#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002987
Jerry Yuf017ee42022-01-12 15:49:48 +08002988/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002989void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2990 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002991{
Jerry Yuf017ee42022-01-12 15:49:48 +08002992#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2993 conf->sig_hashes = NULL;
2994#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2995 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002996}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002998
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002999#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01003000#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003001/*
3002 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003003 *
3004 * mbedtls_ssl_setup() takes the provided list
3005 * and translates it to a list of IANA TLS group identifiers,
3006 * stored in ssl->handshake->group_list.
3007 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003009void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3010 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003011{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003012 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003013 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003014}
Brett Warrene0edc842021-08-17 09:53:13 +01003015#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003016#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003017
Brett Warrene0edc842021-08-17 09:53:13 +01003018/*
3019 * Set the allowed groups
3020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3022 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003023{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003024#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003025 conf->curve_list = NULL;
3026#endif
3027 conf->group_list = group_list;
3028}
3029
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003030#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003031int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003032{
Hanno Becker947194e2017-04-07 13:25:49 +01003033 /* Initialize to suppress unnecessary compiler warning */
3034 size_t hostname_len = 0;
3035
3036 /* Check if new hostname is valid before
3037 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (hostname != NULL) {
3039 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3043 }
Hanno Becker947194e2017-04-07 13:25:49 +01003044 }
3045
3046 /* Now it's clear that we will overwrite the old hostname,
3047 * so we can free it safely */
3048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003050 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003051 }
3052
3053 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003056 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 } else {
3058 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3059 if (ssl->hostname == NULL) {
3060 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3061 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003064
Hanno Becker947194e2017-04-07 13:25:49 +01003065 ssl->hostname[hostname_len] = '\0';
3066 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003069}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003070#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003071
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003072#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003073void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3074 int (*f_sni)(void *, mbedtls_ssl_context *,
3075 const unsigned char *, size_t),
3076 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003077{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003078 conf->f_sni = f_sni;
3079 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003080}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003084int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003085{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003086 size_t cur_len, tot_len;
3087 const char **p;
3088
3089 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003090 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3091 * MUST NOT be truncated."
3092 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003093 */
3094 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 for (p = protos; *p != NULL; p++) {
3096 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003097 tot_len += cur_len;
3098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if ((cur_len == 0) ||
3100 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3101 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3103 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003104 }
3105
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003106 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003109}
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003112{
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003114}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003116
Johan Pascalb62bb512015-12-03 21:56:45 +01003117#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003118void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3119 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003120{
3121 conf->dtls_srtp_mki_support = support_mki_value;
3122}
3123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3125 unsigned char *mki_value,
3126 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003127{
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003130 }
Ron Eldor591f1622018-01-22 12:30:04 +02003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3133 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003134 }
Ron Eldor591f1622018-01-22 12:30:04 +02003135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003137 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003139}
3140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3142 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003143{
Johan Pascal253d0262020-09-22 13:04:45 +02003144 const mbedtls_ssl_srtp_profile *p;
3145 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003146
Johan Pascal253d0262020-09-22 13:04:45 +02003147 /* check the profiles list: all entry must be valid,
3148 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3150 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3151 p++) {
3152 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003153 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003155 /* unsupported value, stop parsing and set the size to an error value */
3156 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003157 }
3158 }
3159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3161 conf->dtls_srtp_profile_list = NULL;
3162 conf->dtls_srtp_profile_list_len = 0;
3163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003164 }
3165
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003166 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003167 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003168
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003170}
3171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3173 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003174{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003175 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3176 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003178 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003180 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3182 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003183 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003184}
Johan Pascalb62bb512015-12-03 21:56:45 +01003185#endif /* MBEDTLS_SSL_DTLS_SRTP */
3186
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303187#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003188void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003189{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003190 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003191}
3192
Gilles Peskine449bd832023-01-11 14:50:10 +01003193void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003194{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003195 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003196}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303197#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003198
Janos Follath088ce432017-04-10 12:42:31 +01003199#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003200void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3201 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003202{
3203 conf->cert_req_ca_list = cert_req_ca_list;
3204}
3205#endif
3206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003208void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003209{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003210 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003211}
3212#endif
3213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003215void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003216{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003217 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003218}
3219#endif
3220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003222int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003223{
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3225 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3226 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003227 }
3228
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003229 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003232}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003234
Gilles Peskine449bd832023-01-11 14:50:10 +01003235void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003237 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003238}
3239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003241void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003242{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003243 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003244}
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003247{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003248 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003249}
3250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3252 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003253{
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003255}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003259#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003260void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003261{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003262 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003263}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003264#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003265
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003266#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003267
Jerry Yud0766ec2022-09-22 10:46:57 +08003268#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003269void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3270 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003271{
Jerry Yud0766ec2022-09-22 10:46:57 +08003272 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003273}
3274#endif
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3277 mbedtls_ssl_ticket_write_t *f_ticket_write,
3278 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3279 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003280{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003281 conf->f_ticket_write = f_ticket_write;
3282 conf->f_ticket_parse = f_ticket_parse;
3283 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003284}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003285#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3289 mbedtls_ssl_export_keys_t *f_export_keys,
3290 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003291{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003292 ssl->f_export_keys = f_export_keys;
3293 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003294}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003295
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003296#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003297void mbedtls_ssl_conf_async_private_cb(
3298 mbedtls_ssl_config *conf,
3299 mbedtls_ssl_async_sign_t *f_async_sign,
3300 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3301 mbedtls_ssl_async_resume_t *f_async_resume,
3302 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003304{
3305 conf->f_async_sign_start = f_async_sign;
3306 conf->f_async_decrypt_start = f_async_decrypt;
3307 conf->f_async_resume = f_async_resume;
3308 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003309 conf->p_async_config_data = async_config_data;
3310}
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003313{
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003315}
3316
Gilles Peskine449bd832023-01-11 14:50:10 +01003317void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003318{
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl->handshake == NULL) {
3320 return NULL;
3321 } else {
3322 return ssl->handshake->user_async_ctx;
3323 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003324}
3325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3327 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003328{
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003330 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003332}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003333#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003334
Paul Bakker5121ce52009-01-03 21:22:43 +00003335/*
3336 * SSL get accessors
3337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003338uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003339{
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (ssl->session != NULL) {
3341 return ssl->session->verify_result;
3342 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003343
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl->session_negotiate != NULL) {
3345 return ssl->session_negotiate->verify_result;
3346 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003347
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003349}
3350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003352{
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 if (ssl == NULL || ssl->session == NULL) {
3354 return 0;
3355 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003356
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003358}
3359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003361{
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (ssl == NULL || ssl->session == NULL) {
3363 return NULL;
3364 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003365
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003367}
3368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003370{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3373 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003374 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003376 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003378 }
3379 }
3380#endif
3381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003383 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003385 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003387 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003389 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003390}
3391
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003392#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3393
3394size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3395{
3396 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3397 size_t record_size_limit = max_len;
3398
3399 if (ssl->session != NULL &&
3400 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3401 ssl->session->record_size_limit < max_len) {
3402 record_size_limit = ssl->session->record_size_limit;
3403 }
3404
3405 // TODO: this is currently untested
3406 /* During a handshake, use the value being negotiated */
3407 if (ssl->session_negotiate != NULL &&
3408 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3409 ssl->session_negotiate->record_size_limit < max_len) {
3410 record_size_limit = ssl->session_negotiate->record_size_limit;
3411 }
3412
3413 return record_size_limit;
3414}
3415#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3416
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003417#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003418size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003419{
David Horstmann95d516f2021-05-04 18:36:56 +01003420 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003421 size_t read_mfl;
3422
Jerry Yuddda0502022-12-01 19:43:12 +08003423#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003424 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3426 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3427 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003428 }
Jerry Yuddda0502022-12-01 19:43:12 +08003429#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003430
3431 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 if (ssl->session_out != NULL) {
3433 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3434 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003435 max_len = read_mfl;
3436 }
3437 }
3438
Jerry Yuddda0502022-12-01 19:43:12 +08003439 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if (ssl->session_negotiate != NULL) {
3441 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3442 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003443 max_len = read_mfl;
3444 }
3445 }
3446
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003448}
3449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003451{
3452 size_t max_len;
3453
3454 /*
3455 * Assume mfl_code is correct since it was checked when set
3456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003458
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003459 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 if (ssl->session_out != NULL &&
3461 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3462 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003463 }
3464
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003465 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003466 if (ssl->session_negotiate != NULL &&
3467 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3468 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003469 }
3470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003472}
3473#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3474
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003475#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003477{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003478 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3480 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3481 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3482 return 0;
3483 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003484
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3486 return ssl->mtu;
3487 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003488
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 if (ssl->mtu == 0) {
3490 return ssl->handshake->mtu;
3491 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003492
Gilles Peskine449bd832023-01-11 14:50:10 +01003493 return ssl->mtu < ssl->handshake->mtu ?
3494 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003495}
3496#endif /* MBEDTLS_SSL_PROTO_DTLS */
3497
Gilles Peskine449bd832023-01-11 14:50:10 +01003498int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003499{
3500 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3501
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003502#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003503 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003504 !defined(MBEDTLS_SSL_PROTO_DTLS)
3505 (void) ssl;
3506#endif
3507
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003508#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003510
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003512 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003514#endif
3515
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003516#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3517 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3518
3519 if (max_len > record_size_limit) {
3520 max_len = record_size_limit;
3521 }
3522#endif
3523
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003524 if (ssl->transform_out != NULL &&
3525 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003526 /*
3527 * In TLS 1.3 case, when records are protected, `max_len` as computed
3528 * above is the maximum length of the TLSInnerPlaintext structure that
3529 * along the plaintext payload contains the inner content type (one byte)
3530 * and some zero padding. Given the algorithm used for padding
3531 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3532 * the plaintext payload. Round down to a multiple of
3533 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3534 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003535 */
3536 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3537 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3538 }
3539
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003540#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003541 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3542 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3543 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003544 const size_t overhead = (size_t) ret;
3545
Gilles Peskine449bd832023-01-11 14:50:10 +01003546 if (ret < 0) {
3547 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003548 }
3549
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 if (mtu <= overhead) {
3551 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3552 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3553 }
3554
3555 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003556 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003557 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003558 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003559#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003560
Hanno Becker0defedb2018-08-10 12:35:02 +01003561#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003562 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3563 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003564 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003565#endif
3566
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003568}
3569
Gilles Peskine449bd832023-01-11 14:50:10 +01003570int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003571{
3572 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3573
3574#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3575 (void) ssl;
3576#endif
3577
3578#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003580
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003582 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003583 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003584#endif
3585
Gilles Peskine449bd832023-01-11 14:50:10 +01003586 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003587}
3588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003590const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003591{
Gilles Peskine449bd832023-01-11 14:50:10 +01003592 if (ssl == NULL || ssl->session == NULL) {
3593 return NULL;
3594 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003595
Hanno Beckere6824572019-02-07 13:18:46 +00003596#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003598#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003599 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003600#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003601}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003605int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3606 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003607{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003608 int ret;
3609
Gilles Peskine449bd832023-01-11 14:50:10 +01003610 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003611 dst == NULL ||
3612 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003613 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003615 }
3616
Hanno Beckere810bbc2021-05-14 16:01:05 +01003617 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3618 * idempotent: Each session can only be exported once.
3619 *
3620 * (This is in preparation for TLS 1.3 support where we will
3621 * need the ability to export multiple sessions (aka tickets),
3622 * which will be achieved by calling mbedtls_ssl_get_session()
3623 * multiple times until it fails.)
3624 *
3625 * Check whether we have already exported the current session,
3626 * and fail if so.
3627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003628 if (ssl->session->exported == 1) {
3629 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3630 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003631
Gilles Peskine449bd832023-01-11 14:50:10 +01003632 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3633 if (ret != 0) {
3634 return ret;
3635 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003636
3637 /* Remember that we've exported the session. */
3638 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003640}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003642
Paul Bakker5121ce52009-01-03 21:22:43 +00003643/*
Hanno Beckera835da52019-05-16 12:39:07 +01003644 * Define ticket header determining Mbed TLS version
3645 * and structure of the ticket.
3646 */
3647
Hanno Becker94ef3b32019-05-16 12:50:45 +01003648/*
Hanno Becker50b59662019-05-28 14:30:45 +01003649 * Define bitflag determining compile-time settings influencing
3650 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003651 */
3652
Hanno Becker50b59662019-05-28 14:30:45 +01003653#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003654#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003655#else
Hanno Becker3e088662019-05-29 11:10:18 +01003656#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003657#endif /* MBEDTLS_HAVE_TIME */
3658
3659#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003660#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003661#else
Hanno Becker3e088662019-05-29 11:10:18 +01003662#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003663#endif /* MBEDTLS_X509_CRT_PARSE_C */
3664
3665#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003666#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003667#else
Hanno Becker3e088662019-05-29 11:10:18 +01003668#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003669#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3670
3671#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003672#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003673#else
Hanno Becker3e088662019-05-29 11:10:18 +01003674#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003675#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3676
Hanno Becker94ef3b32019-05-16 12:50:45 +01003677#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003678#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003679#else
Hanno Becker3e088662019-05-29 11:10:18 +01003680#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003681#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3682
Hanno Becker94ef3b32019-05-16 12:50:45 +01003683#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3684#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3685#else
3686#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3687#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3688
Hanno Becker3e088662019-05-29 11:10:18 +01003689#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3690#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3691#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3692#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003693#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3694#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003695
Hanno Becker50b59662019-05-28 14:30:45 +01003696#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003697 ((uint16_t) ( \
3698 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3699 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3700 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3701 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3702 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3703 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3704 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003705
Hanno Beckerf8787072019-05-16 12:41:07 +01003706static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003707 MBEDTLS_VERSION_MAJOR,
3708 MBEDTLS_VERSION_MINOR,
3709 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003710 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3711 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003712};
Hanno Beckera835da52019-05-16 12:39:07 +01003713
3714/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003715 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003716 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003717 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003718 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003719 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003720 * opaque mbedtls_version[3]; // library version: major, minor, patch
3721 * opaque session_format[2]; // library-version specific 16-bit field
3722 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003723 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003724 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003725 * Note: When updating the format, remember to keep
3726 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003727 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728 * // In this version, `session_format` determines
3729 * // the setting of those compile-time
3730 * // configuration options which influence
3731 * // the structure of mbedtls_ssl_session.
3732 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003733 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003734 * // - TLS 1.2 (0x0303)
3735 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003736 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003737 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003738 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003739 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003740 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003741 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003742 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003743 *
3744 * };
3745 *
3746 * } serialized_session;
3747 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003748 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003749
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003750MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003751static int ssl_session_save(const mbedtls_ssl_session *session,
3752 unsigned char omit_header,
3753 unsigned char *buf,
3754 size_t buf_len,
3755 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003756{
3757 unsigned char *p = buf;
3758 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003759 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3761 size_t out_len;
3762 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3763#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 if (session == NULL) {
3765 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3766 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003767
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003769 /*
3770 * Add Mbed TLS version identifier
3771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003773
Gilles Peskine449bd832023-01-11 14:50:10 +01003774 if (used <= buf_len) {
3775 memcpy(p, ssl_serialized_session_header,
3776 sizeof(ssl_serialized_session_header));
3777 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003778 }
3779 }
3780
3781 /*
3782 * TLS version identifier
3783 */
3784 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 if (used <= buf_len) {
3786 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003787 }
3788
3789 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003790 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003791 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003793 case MBEDTLS_SSL_VERSION_TLS1_2:
3794 used += ssl_tls12_session_save(session, p, remaining_len);
3795 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003796#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3797
Jerry Yu251a12e2022-07-13 15:15:48 +08003798#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003799 case MBEDTLS_SSL_VERSION_TLS1_3:
3800 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3801 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3802 return ret;
3803 }
3804 used += out_len;
3805 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003806#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3807
Gilles Peskine449bd832023-01-11 14:50:10 +01003808 default:
3809 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003810 }
3811
3812 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003813 if (used > buf_len) {
3814 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3815 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003816
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003818}
3819
3820/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003821 * Public wrapper for ssl_session_save()
3822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003823int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3824 unsigned char *buf,
3825 size_t buf_len,
3826 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003827{
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003829}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003830
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003831/*
3832 * Deserialize session, see mbedtls_ssl_session_save() for format.
3833 *
3834 * This internal version is wrapped by a public function that cleans up in
3835 * case of error, and has an extra option omit_header.
3836 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003838static int ssl_session_load(mbedtls_ssl_session *session,
3839 unsigned char omit_header,
3840 const unsigned char *buf,
3841 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003842{
3843 const unsigned char *p = buf;
3844 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003845 size_t remaining_len;
3846
3847
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 if (session == NULL) {
3849 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3850 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003851
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003853 /*
3854 * Check Mbed TLS version identifier
3855 */
3856
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3858 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003860
3861 if (memcmp(p, ssl_serialized_session_header,
3862 sizeof(ssl_serialized_session_header)) != 0) {
3863 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3864 }
3865 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003866 }
3867
3868 /*
3869 * TLS version identifier
3870 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003871 if (1 > (size_t) (end - p)) {
3872 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3873 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003874 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003875
3876 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003877 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003879#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 case MBEDTLS_SSL_VERSION_TLS1_2:
3881 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003882#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3883
Jerry Yu438ddd82022-07-07 06:55:50 +00003884#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 case MBEDTLS_SSL_VERSION_TLS1_3:
3886 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003887#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3888
Gilles Peskine449bd832023-01-11 14:50:10 +01003889 default:
3890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003891 }
3892}
3893
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003894/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003895 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003897int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3898 const unsigned char *buf,
3899 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003900{
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003902
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 if (ret != 0) {
3904 mbedtls_ssl_session_free(session);
3905 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003906
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003908}
3909
3910/*
Paul Bakker1961b702013-01-25 14:49:24 +01003911 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003912 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003914static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003915{
3916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3917
Ronald Cron66dbf912022-02-02 15:33:46 +01003918 /*
3919 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003920 * that were written into the output buffer by the previous handshake step,
3921 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003922 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3923 * We proceed to the next handshake step only when all data from the
3924 * previous one have been sent to the peer, thus we make sure that this is
3925 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3926 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3927 * we have to wait before to go ahead.
3928 * In the case of TLS 1.3, handshake step handlers do not send data to the
3929 * peer. Data are only sent here and through
3930 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003931 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3934 return ret;
3935 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003936
3937#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3939 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3940 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3941 return ret;
3942 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003943 }
3944#endif /* MBEDTLS_SSL_PROTO_DTLS */
3945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003947}
3948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003950{
Hanno Becker41934dd2021-08-07 19:13:43 +01003951 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003954 ssl->conf == NULL ||
3955 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3957 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003958 }
3959
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 ret = ssl_prepare_handshake_step(ssl);
3961 if (ret != 0) {
3962 return ret;
3963 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003964
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 ret = mbedtls_ssl_handle_pending_alert(ssl);
3966 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003967 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 }
Jerry Yue7047812021-09-13 19:26:39 +08003969
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003970 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3971 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3972 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003974#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3976 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003977 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003978
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003980 case MBEDTLS_SSL_HELLO_REQUEST:
3981 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003982 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003983 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003984
Ronald Cron9f0fba32022-02-10 16:45:15 +01003985 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003987 break;
3988
3989 default:
3990#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3992 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3993 } else {
3994 ret = mbedtls_ssl_handshake_client_step(ssl);
3995 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003996#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003998#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004000#endif
4001 }
Jerry Yub9930e72021-08-06 17:11:51 +08004002 }
Ronald Cron6291b232023-03-08 15:51:25 +01004003#endif /* MBEDTLS_SSL_CLI_C */
4004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004007#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4008 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004010 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 ret = mbedtls_ssl_handshake_server_step(ssl);
4012 }
Ronald Cron6291b232023-03-08 15:51:25 +01004013#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4014 ret = mbedtls_ssl_handshake_server_step(ssl);
4015#else
4016 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004017#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004018 }
4019#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004022 /* handshake_step return error. And it is same
4023 * with alert_reason.
4024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 if (ssl->send_alert) {
4026 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004027 goto cleanup;
4028 }
4029 }
4030
4031cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004033}
4034
4035/*
4036 * Perform the SSL handshake
4037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004038int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004039{
4040 int ret = 0;
4041
Hanno Beckera817ea42020-10-20 15:20:23 +01004042 /* Sanity checks */
4043
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (ssl == NULL || ssl->conf == NULL) {
4045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4046 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004047
Hanno Beckera817ea42020-10-20 15:20:23 +01004048#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4050 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4051 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4052 "mbedtls_ssl_set_timer_cb() for DTLS"));
4053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004054 }
4055#endif /* MBEDTLS_SSL_PROTO_DTLS */
4056
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004058
Hanno Beckera817ea42020-10-20 15:20:23 +01004059 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4061 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004062
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004064 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 }
Paul Bakker1961b702013-01-25 14:49:24 +01004066 }
4067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004071}
4072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073#if defined(MBEDTLS_SSL_RENEGOTIATION)
4074#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004075/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004076 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004077 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004078MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004079static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004080{
Janos Follath865b3eb2019-12-16 11:46:15 +00004081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004084
4085 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004086 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4087 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4090 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4091 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004092 }
4093
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004097}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004098#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004099
4100/*
4101 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004102 * - any side: calling mbedtls_ssl_renegotiate(),
4103 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4104 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004105 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004106 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004109int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004110{
Janos Follath865b3eb2019-12-16 11:46:15 +00004111 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004114
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if ((ret = ssl_handshake_init(ssl)) != 0) {
4116 return ret;
4117 }
Paul Bakker48916f92012-09-16 19:57:18 +00004118
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004119 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4120 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004121#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4123 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4124 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004125 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004127 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004129 }
4130#endif
4131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004132 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4133 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4136 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4137 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004138 }
4139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004141
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004143}
4144
4145/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004146 * Renegotiate current connection on client,
4147 * or request renegotiation on server
4148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004149int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004150{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004151 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 if (ssl == NULL || ssl->conf == NULL) {
4154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4155 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004157#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004158 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4160 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4162 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004164 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004165
4166 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (ssl->out_left != 0) {
4168 return mbedtls_ssl_flush_output(ssl);
4169 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004172 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004175#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004176 /*
4177 * On client, either start the renegotiation process or,
4178 * if already in progress, continue the handshake
4179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4181 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004183 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004184
4185 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4186 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4187 return ret;
4188 }
4189 } else {
4190 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4191 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4192 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004193 }
4194 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004195#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004198}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004199#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004202{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004203 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004206 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004208
Valerio Setti6f0441d2023-07-03 12:11:36 +02004209#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004210#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (ssl->handshake->group_list_heap_allocated) {
4212 mbedtls_free((void *) handshake->group_list);
4213 }
Brett Warrene0edc842021-08-17 09:53:13 +01004214 handshake->group_list = NULL;
4215#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004216#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004217
Ronald Crone68ab4f2022-10-05 12:46:29 +02004218#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004219#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 if (ssl->handshake->sig_algs_heap_allocated) {
4221 mbedtls_free((void *) handshake->sig_algs);
4222 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004223 handshake->sig_algs = NULL;
4224#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004225#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 if (ssl->handshake->certificate_request_context) {
4227 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004228 }
4229#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004230#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004231
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004232#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4234 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004235 handshake->async_in_progress = 0;
4236 }
4237#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4238
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004239#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004240#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004242#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004243 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004244#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004245#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004246#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004247#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004249#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004250 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004251#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004252#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004254#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004256#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004257#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004258 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004260#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004261
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004262#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004263#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004265 /*
4266 * Opaque keys are not stored in the handshake's data and it's the user
4267 * responsibility to destroy them. Clear ones, instead, are created by
4268 * the TLS library and should be destroyed at the same level
4269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4271 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004272 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004273 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4274#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004276#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004277#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004279 handshake->ecjpake_cache = NULL;
4280 handshake->ecjpake_cache_len = 0;
4281#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004282#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004283
Valerio Setti7aeec542023-07-05 18:57:21 +02004284#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004285 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004286 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004287 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004289#endif
4290
Ronald Cron73fe8df2022-10-05 14:31:43 +02004291#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004292#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004294 /* The maintenance of the external PSK key slot is the
4295 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (ssl->handshake->psk_opaque_is_internal) {
4297 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004298 ssl->handshake->psk_opaque_is_internal = 0;
4299 }
4300 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4301 }
Neil Armstronge952a302022-05-03 10:22:14 +02004302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004304 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004305 }
Neil Armstronge952a302022-05-03 10:22:14 +02004306#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004307#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004309#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4310 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004311 /*
4312 * Free only the linked list wrapper, not the keys themselves
4313 * since the belong to the SNI callback
4314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004316#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004317
Gilles Peskineeccd8882020-03-10 12:19:08 +01004318#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4320 if (handshake->ecrs_peer_cert != NULL) {
4321 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4322 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004323 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004324#endif
4325
Hanno Becker75173122019-02-06 16:18:31 +00004326#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4327 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004329#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4330
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004331#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4333 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004334#endif /* MBEDTLS_SSL_CLI_C &&
4335 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004336
4337#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 mbedtls_ssl_flight_free(handshake->flight);
4339 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004340#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004341
Valerio Settiea59c432023-07-25 11:14:03 +02004342#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004343 if (handshake->xxdh_psa_privkey_is_external == 0) {
4344 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 }
Valerio Settiea59c432023-07-25 11:14:03 +02004346#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004347
Ronald Cron6f135e12021-12-08 16:57:54 +01004348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 mbedtls_ssl_transform_free(handshake->transform_handshake);
4350 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004351#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4353 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004354#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004355#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004356
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004357
4358#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4359 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4360 * processes datagrams and the fact that a datagram is allowed to have
4361 * several records in it, it is possible that the I/O buffers are not
4362 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4364 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004365#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004366
Jerry Yuba9c7272021-10-30 11:54:10 +08004367 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 mbedtls_platform_zeroize(handshake,
4369 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004370}
4371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004373{
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004375 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004378#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004380#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004381
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004382#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004383#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4384 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004386#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004388#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004391}
4392
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004394
4395#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4396#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4397#else
4398#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4399#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4400
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004401#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004402
4403#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4404#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4405#else
4406#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4407#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4408
4409#if defined(MBEDTLS_SSL_ALPN)
4410#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4411#else
4412#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4413#endif /* MBEDTLS_SSL_ALPN */
4414
4415#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4416#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4417#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4418#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4419
4420#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 ((uint32_t) ( \
4422 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4423 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4424 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4425 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4426 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4427 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4428 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4429 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004430
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004431static unsigned char ssl_serialized_context_header[] = {
4432 MBEDTLS_VERSION_MAJOR,
4433 MBEDTLS_VERSION_MINOR,
4434 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4436 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4437 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4438 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4439 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004440};
4441
Paul Bakker5121ce52009-01-03 21:22:43 +00004442/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004443 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004444 *
4445 * The format of the serialized data is:
4446 * (in the presentation language of TLS, RFC 8446 section 3)
4447 *
4448 * // header
4449 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004450 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004451 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004452 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004453 * Note: When updating the format, remember to keep these
4454 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004455 *
4456 * // session sub-structure
4457 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4458 * // transform sub-structure
4459 * uint8 random[64]; // ServerHello.random+ClientHello.random
4460 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4461 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4462 * // fields from ssl_context
4463 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4464 * uint64 in_window_top; // DTLS: last validated record seq_num
4465 * uint64 in_window; // DTLS: bitmask for replay protection
4466 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4467 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4468 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4469 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4470 *
4471 * Note that many fields of the ssl_context or sub-structures are not
4472 * serialized, as they fall in one of the following categories:
4473 *
4474 * 1. forced value (eg in_left must be 0)
4475 * 2. pointer to dynamically-allocated memory (eg session, transform)
4476 * 3. value can be re-derived from other data (eg session keys from MS)
4477 * 4. value was temporary (eg content of input buffer)
4478 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004480int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4481 unsigned char *buf,
4482 size_t buf_len,
4483 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004484{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004485 unsigned char *p = buf;
4486 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004487 size_t session_len;
4488 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004489
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004490 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004491 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4492 * this function's documentation.
4493 *
4494 * These are due to assumptions/limitations in the implementation. Some of
4495 * them are likely to stay (no handshake in progress) some might go away
4496 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004497 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004498 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4500 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4501 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004502 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (ssl->handshake != NULL) {
4504 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004506 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004507 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (ssl->transform == NULL || ssl->session == NULL) {
4509 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004511 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004512 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 if (mbedtls_ssl_check_pending(ssl) != 0) {
4514 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004516 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (ssl->out_left != 0) {
4518 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4519 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004520 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004521 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4523 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4524 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004525 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004526 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4528 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4529 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004530 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004531 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4533 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4534 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004535 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004536 /* Renegotiation must not be enabled */
4537#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4539 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4540 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004541 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004542#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004543
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004544 /*
4545 * Version and format identifier
4546 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 if (used <= buf_len) {
4550 memcpy(p, ssl_serialized_context_header,
4551 sizeof(ssl_serialized_context_header));
4552 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004553 }
4554
4555 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004556 * Session (length + data)
4557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4559 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4560 return ret;
4561 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004562
4563 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 if (used <= buf_len) {
4565 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004566 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004567
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 ret = ssl_session_save(ssl->session, 1,
4569 p, session_len, &session_len);
4570 if (ret != 0) {
4571 return ret;
4572 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004573
4574 p += session_len;
4575 }
4576
4577 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004578 * Transform
4579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 used += sizeof(ssl->transform->randbytes);
4581 if (used <= buf_len) {
4582 memcpy(p, ssl->transform->randbytes,
4583 sizeof(ssl->transform->randbytes));
4584 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004585 }
4586
4587#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004588 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004590 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004592 p += ssl->transform->in_cid_len;
4593
4594 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004596 p += ssl->transform->out_cid_len;
4597 }
4598#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4599
4600 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004601 * Saved fields from top-level ssl_context structure
4602 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004603 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 if (used <= buf_len) {
4605 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004606 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004607 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004608
4609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4610 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (used <= buf_len) {
4612 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004613 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004616 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004617 }
4618#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4619
4620#if defined(MBEDTLS_SSL_PROTO_DTLS)
4621 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004623 *p++ = ssl->disable_datagram_packing;
4624 }
4625#endif /* MBEDTLS_SSL_PROTO_DTLS */
4626
Jerry Yuae0b2e22021-10-08 15:21:19 +08004627 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (used <= buf_len) {
4629 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004630 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004631 }
4632
4633#if defined(MBEDTLS_SSL_PROTO_DTLS)
4634 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (used <= buf_len) {
4636 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004637 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004638 }
4639#endif /* MBEDTLS_SSL_PROTO_DTLS */
4640
4641#if defined(MBEDTLS_SSL_ALPN)
4642 {
4643 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004645 : 0;
4646
4647 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004649 *p++ = alpn_len;
4650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if (ssl->alpn_chosen != NULL) {
4652 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004653 p += alpn_len;
4654 }
4655 }
4656 }
4657#endif /* MBEDTLS_SSL_ALPN */
4658
4659 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004660 * Done
4661 */
4662 *olen = used;
4663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (used > buf_len) {
4665 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4666 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004671}
4672
4673/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004674 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004675 *
4676 * This internal version is wrapped by a public function that cleans up in
4677 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004678 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004679MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004680static int ssl_context_load(mbedtls_ssl_context *ssl,
4681 const unsigned char *buf,
4682 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004683{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004684 const unsigned char *p = buf;
4685 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004686 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004689 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004690#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004691
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004692 /*
4693 * The context should have been freshly setup or reset.
4694 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004695 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004696 * renegotiating, or if the user mistakenly loaded a session first.)
4697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4699 ssl->session != NULL) {
4700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004701 }
4702
4703 /*
4704 * We can't check that the config matches the initial one, but we can at
4705 * least check it matches the requirements for serializing.
4706 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004707 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004708#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004709 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004710#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004711 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4712 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4713 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4714 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004716 }
4717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004719
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004720 /*
4721 * Check version identifier
4722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004725 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004726
4727 if (memcmp(p, ssl_serialized_context_header,
4728 sizeof(ssl_serialized_context_header)) != 0) {
4729 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4730 }
4731 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004732
4733 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004734 * Session
4735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if ((size_t) (end - p) < 4) {
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4738 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004739
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004740 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004741 p += 4;
4742
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004743 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004744 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004745 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004746 ssl->session_in = ssl->session;
4747 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004748 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if ((size_t) (end - p) < session_len) {
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4752 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 ret = ssl_session_load(ssl->session, 1, p, session_len);
4755 if (ret != 0) {
4756 mbedtls_ssl_session_free(ssl->session);
4757 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004758 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004759
4760 p += session_len;
4761
4762 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004763 * Transform
4764 */
4765
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004766 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004767 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004768#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004769 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004770 ssl->transform_in = ssl->transform;
4771 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004772 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004773#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004774
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004775#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4777 if (prf_func == NULL) {
4778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4779 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004780
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004781 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4784 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 ret = ssl_tls12_populate_transform(ssl->transform,
4787 ssl->session->ciphersuite,
4788 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004789#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004791#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 prf_func,
4793 p, /* currently pointing to randbytes */
4794 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4795 ssl->conf->endpoint,
4796 ssl);
4797 if (ret != 0) {
4798 return ret;
4799 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004800#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004802
4803#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4804 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if ((size_t) (end - p) < 1) {
4806 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4807 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004808
4809 ssl->transform->in_cid_len = *p++;
4810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4812 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4813 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004816 p += ssl->transform->in_cid_len;
4817
4818 ssl->transform->out_cid_len = *p++;
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4821 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4822 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004825 p += ssl->transform->out_cid_len;
4826#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4827
4828 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004829 * Saved fields from top-level ssl_context structure
4830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if ((size_t) (end - p) < 4) {
4832 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4833 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004834
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004835 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004836 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004837
4838#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if ((size_t) (end - p) < 16) {
4840 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4841 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004842
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004843 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004844 p += 8;
4845
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004846 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004847 p += 8;
4848#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4849
4850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if ((size_t) (end - p) < 1) {
4852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4853 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004854
4855 ssl->disable_datagram_packing = *p++;
4856#endif /* MBEDTLS_SSL_PROTO_DTLS */
4857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4859 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4860 }
4861 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4862 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004863
4864#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if ((size_t) (end - p) < 2) {
4866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4867 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004868
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004869 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004870 p += 2;
4871#endif /* MBEDTLS_SSL_PROTO_DTLS */
4872
4873#if defined(MBEDTLS_SSL_ALPN)
4874 {
4875 uint8_t alpn_len;
4876 const char **cur;
4877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if ((size_t) (end - p) < 1) {
4879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4880 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004881
4882 alpn_len = *p++;
4883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004885 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4887 if (strlen(*cur) == alpn_len &&
4888 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004889 ssl->alpn_chosen = *cur;
4890 break;
4891 }
4892 }
4893 }
4894
4895 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4897 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4898 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004899
4900 p += alpn_len;
4901 }
4902#endif /* MBEDTLS_SSL_ALPN */
4903
4904 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004905 * Forced fields from top-level ssl_context structure
4906 *
4907 * Most of them already set to the correct value by mbedtls_ssl_init() and
4908 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4909 */
4910 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004911 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004912
Hanno Becker361b10d2019-08-30 10:42:49 +01004913 /* Adjust pointers for header fields of outgoing records to
4914 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004916
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004917#if defined(MBEDTLS_SSL_PROTO_DTLS)
4918 ssl->in_epoch = 1;
4919#endif
4920
4921 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4922 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004923 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4924 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (ssl->handshake != NULL) {
4926 mbedtls_ssl_handshake_free(ssl);
4927 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004928 ssl->handshake = NULL;
4929 }
4930
4931 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004932 * Done - should have consumed entire buffer
4933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 if (p != end) {
4935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4936 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004939}
4940
4941/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004942 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004944int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4945 const unsigned char *buf,
4946 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004947{
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 if (ret != 0) {
4951 mbedtls_ssl_free(context);
4952 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004955}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004956#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004957
4958/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004959 * Free an SSL context
4960 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004961void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004962{
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004964 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004970#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4971 size_t out_buf_len = ssl->out_buf_len;
4972#else
4973 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4974#endif
4975
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004976 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004977 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 }
4979
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004981#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4982 size_t in_buf_len = ssl->in_buf_len;
4983#else
4984 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4985#endif
4986
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004987 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004988 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004989 }
4990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 if (ssl->transform) {
4992 mbedtls_ssl_transform_free(ssl->transform);
4993 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004994 }
4995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 if (ssl->handshake) {
4997 mbedtls_ssl_handshake_free(ssl);
4998 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004999
5000#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5002 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005003#endif
5004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 mbedtls_ssl_session_free(ssl->session_negotiate);
5006 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005007 }
5008
Ronald Cron6f135e12021-12-08 16:57:54 +01005009#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 mbedtls_ssl_transform_free(ssl->transform_application);
5011 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005012#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 if (ssl->session) {
5015 mbedtls_ssl_session_free(ssl->session);
5016 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005017 }
5018
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005019#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005021 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005022 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005023#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005024
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005025#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005027#endif
5028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005030
Paul Bakker86f04f42013-02-14 11:20:09 +01005031 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005033}
5034
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005035/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005036 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005039{
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005041}
5042
Gilles Peskineae270bf2021-06-02 00:05:29 +02005043/* The selection should be the same as mbedtls_x509_crt_profile_default in
5044 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005045 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005046 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005047 * about this list.
5048 */
Brett Warrene0edc842021-08-17 09:53:13 +01005049static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005050#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005051 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005052#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005053#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005054 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005055#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005056#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005057 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005058#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005059#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005060 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005061#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005062#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005063 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005064#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005065#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005066 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005067#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005068#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005069 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005070#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005071#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005072 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005073#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005074#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005075 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5076 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5077 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5078 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5079 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5080#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005081 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005082};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005083
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005084static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005085 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5086 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5087 0
5088};
5089
Ronald Crone68ab4f2022-10-05 12:46:29 +02005090#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005091
Jerry Yu909df7b2022-01-22 11:56:27 +08005092/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005093 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005094 * rules SHOULD be upheld.
5095 * - No duplicate entries.
5096 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005097 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005098 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005099 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005100static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005101
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005102#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005103 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005104 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005105 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005106 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5107#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005108
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005109#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005110 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005111 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005112 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005113 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5114#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005115
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005116#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005117 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005118 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005119 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005120 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5121#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005122
Yanray Wang1136fad2023-11-22 16:54:31 +08005123#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005124 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005125#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005126
Yanray Wang1136fad2023-11-22 16:54:31 +08005127#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005128 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005129#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005130
Yanray Wang1136fad2023-11-22 16:54:31 +08005131#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005132 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005133#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005134
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005135#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005136 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005137#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005138
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005139#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005140 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005141#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005142
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005143#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005144 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005145#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005146
Gabor Mezei15b95a62022-05-09 16:37:58 +02005147 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005148};
5149
5150/* NOTICE: see above */
5151#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5152static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005153
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005154#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005155#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005157#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005158#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5159 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005160#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005161#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005163#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005164#endif /* MBEDTLS_MD_CAN_SHA512 */
5165
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005166#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005167#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005169#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005170#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5171 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005172#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005173#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005175#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005176#endif /* MBEDTLS_MD_CAN_SHA384 */
5177
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005178#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005179#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005181#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005182#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5183 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005184#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005185#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005187#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005188#endif /* MBEDTLS_MD_CAN_SHA256 */
5189
Gabor Mezei15b95a62022-05-09 16:37:58 +02005190 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005191};
5192#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005193
Jerry Yu909df7b2022-01-22 11:56:27 +08005194/* NOTICE: see above */
5195static uint16_t ssl_preset_suiteb_sig_algs[] = {
5196
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005197#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005198 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005199 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005200 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005201 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5202#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005203
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005204#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005205 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005206 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005207 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005208 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5209#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005210
Gabor Mezei15b95a62022-05-09 16:37:58 +02005211 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005212};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005213
Jerry Yu909df7b2022-01-22 11:56:27 +08005214/* NOTICE: see above */
5215#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5216static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005217
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005218#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005219#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005221#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005222#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005223
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005224#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005225#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005227#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005228#endif /* MBEDTLS_MD_CAN_SHA384 */
5229
Gabor Mezei15b95a62022-05-09 16:37:58 +02005230 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005231};
Jerry Yu909df7b2022-01-22 11:56:27 +08005232#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5233
Ronald Crone68ab4f2022-10-05 12:46:29 +02005234#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005235
Brett Warrene0edc842021-08-17 09:53:13 +01005236static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005237#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005238 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005240#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005241 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005242#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005243 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005244};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005245
Ronald Crone68ab4f2022-10-05 12:46:29 +02005246#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005247/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005248 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005250static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005251{
5252 size_t i, j;
5253 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5256 for (j = 0; j < i; j++) {
5257 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005258 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 }
5260 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5261 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5262 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005263 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005264 }
5265 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005267}
5268
Ronald Crone68ab4f2022-10-05 12:46:29 +02005269#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005270
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005272 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5275 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005276{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005277#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005279#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005280
Ronald Crone68ab4f2022-10-05 12:46:29 +02005281#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5283 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5284 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005285 }
5286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5288 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5289 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005290 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005291
5292#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5294 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5295 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005296 }
5297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5299 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5300 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005301 }
5302#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005303#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005304
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005305 /* Use the functions here so that they are covered in tests,
5306 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 mbedtls_ssl_conf_endpoint(conf, endpoint);
5308 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005309
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005310 /*
5311 * Things that are common to all presets
5312 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005313#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005315 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5316#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5317 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5318#endif
5319 }
5320#endif
5321
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005322#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5323 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5324#endif
5325
5326#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5327 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5328#endif
5329
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005330#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005331 conf->f_cookie_write = ssl_cookie_write_dummy;
5332 conf->f_cookie_check = ssl_cookie_check_dummy;
5333#endif
5334
5335#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5336 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5337#endif
5338
Janos Follath088ce432017-04-10 12:42:31 +01005339#if defined(MBEDTLS_SSL_SRV_C)
5340 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005341 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005342#endif
5343
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005344#if defined(MBEDTLS_SSL_PROTO_DTLS)
5345 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5346 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5347#endif
5348
5349#if defined(MBEDTLS_SSL_RENEGOTIATION)
5350 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 memset(conf->renego_period, 0x00, 2);
5352 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005353#endif
5354
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005357 const unsigned char dhm_p[] =
5358 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5359 const unsigned char dhm_g[] =
5360 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5363 dhm_p, sizeof(dhm_p),
5364 dhm_g, sizeof(dhm_g))) != 0) {
5365 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005366 }
5367 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005368#endif
5369
Ronald Cron6f135e12021-12-08 16:57:54 +01005370#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005371
5372#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005373 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005374#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005375 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005376#endif
5377#endif /* MBEDTLS_SSL_EARLY_DATA */
5378
Jerry Yud0766ec2022-09-22 10:46:57 +08005379#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005380 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005382#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005383 /*
5384 * Allow all TLS 1.3 key exchange modes by default.
5385 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005386 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005387#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005388
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005390#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005391 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005392 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005397#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005398 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5399 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005400#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5401 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5402 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5403#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5404 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5405 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5406#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005408#endif
5409 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005410
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005411 /*
5412 * Preset-specific defaults
5413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005415 /*
5416 * NSA Suite B
5417 */
5418 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005419
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005420 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005421
5422#if defined(MBEDTLS_X509_CRT_PARSE_C)
5423 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005424#endif
5425
Ronald Crone68ab4f2022-10-05 12:46:29 +02005426#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005427#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005429 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005431#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005433#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005434
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005435#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005436 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005437#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005438 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005439 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005440
5441 /*
5442 * Default
5443 */
5444 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005445
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005446 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005447
5448#if defined(MBEDTLS_X509_CRT_PARSE_C)
5449 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5450#endif
5451
Ronald Crone68ab4f2022-10-05 12:46:29 +02005452#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005453#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005455 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005457#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005459#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005460
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005461#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005462 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005463#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005464 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005465
5466#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5467 conf->dhm_min_bitlen = 1024;
5468#endif
5469 }
5470
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005472}
5473
5474/*
5475 * Free mbedtls_ssl_config
5476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005478{
5479#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 mbedtls_mpi_free(&conf->dhm_P);
5481 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005482#endif
5483
Ronald Cron73fe8df2022-10-05 14:31:43 +02005484#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005485#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005487 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5488 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005489#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005491 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005492 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005493 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005494 }
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005497 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005498 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005499 conf->psk_identity_len = 0;
5500 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005501#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005502
5503#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005505#endif
5506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005508}
5509
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005510#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005511 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005512/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005515unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005516{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5519 return MBEDTLS_SSL_SIG_RSA;
5520 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005521#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005522#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5524 return MBEDTLS_SSL_SIG_ECDSA;
5525 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005526#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005528}
5529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005531{
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005533 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005535 case MBEDTLS_PK_ECDSA:
5536 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005538 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005540 }
5541}
5542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005544{
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546#if defined(MBEDTLS_RSA_C)
5547 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005549#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005550#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005551 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005553#endif
5554 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005556 }
5557}
Valerio Settie9646ec2023-08-02 20:02:28 +02005558#endif /* MBEDTLS_PK_C &&
5559 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005560
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005561/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005562 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005563 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005564mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005565{
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005567#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005568 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005570#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005571#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005574#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005575#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005578#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005579#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005580 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005582#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005583#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005586#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005587#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005590#endif
5591 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005593 }
5594}
5595
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005596/*
5597 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005599unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005600{
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005602#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005603 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005605#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005606#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005607 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005609#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005610#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005611 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005613#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005614#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005615 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005617#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005618#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005619 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005621#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005622#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005623 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005625#endif
5626 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005628 }
5629}
5630
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005631/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005632 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005633 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005635int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005636{
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 if (group_list == NULL) {
5640 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005641 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 for (; *group_list != 0; group_list++) {
5644 if (*group_list == tls_id) {
5645 return 0;
5646 }
5647 }
5648
5649 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005650}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005651
Valerio Setti49e69072023-06-27 17:27:51 +02005652#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005653/*
5654 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5655 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005656int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005657{
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005659
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005661 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005663
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005665}
Valerio Setti49e69072023-06-27 17:27:51 +02005666#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005667
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668static const struct {
5669 uint16_t tls_id;
5670 mbedtls_ecp_group_id ecp_group_id;
5671 psa_ecc_family_t psa_family;
5672 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673} tls_id_match_table[] =
5674{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005675#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005676 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005678#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005679 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005680#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005681#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005682 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005684#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005685 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005686#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005687#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005688 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005689#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005690#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005691 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005692#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005693#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005694 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005695#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005696#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005697 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005698#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005699#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005700 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005701#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005702#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005703 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005704#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005705#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005706 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005707#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005708#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005709 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005710#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005711#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005712 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005713#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005714 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005715};
5716
Gilles Peskine449bd832023-01-11 14:50:10 +01005717int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005718 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005720{
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5722 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005723 if (type != NULL) {
5724 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 }
5726 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005727 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005729 return PSA_SUCCESS;
5730 }
5731 }
5732
5733 return PSA_ERROR_NOT_SUPPORTED;
5734}
5735
Gilles Peskine449bd832023-01-11 14:50:10 +01005736mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005737{
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5739 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005740 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005742 }
5743
5744 return MBEDTLS_ECP_DP_NONE;
5745}
5746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005748{
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5750 i++) {
5751 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005752 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005754 }
5755
5756 return 0;
5757}
5758
Valerio Setti67419f02023-01-04 16:12:42 +01005759#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005760static const struct {
5761 uint16_t tls_id;
5762 const char *name;
5763} tls_id_curve_name_table[] =
5764{
Valerio Setti54e23792023-07-07 10:49:27 +02005765 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5766 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5767 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5768 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5769 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5770 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5771 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5772 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5773 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5774 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5775 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5776 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5777 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005778 { 0, NULL },
5779};
5780
Gilles Peskine449bd832023-01-11 14:50:10 +01005781const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005782{
Valerio Settiacd32c02023-06-29 18:06:29 +02005783 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5784 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5785 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005787 }
5788
5789 return NULL;
5790}
Valerio Setti67419f02023-01-04 16:12:42 +01005791#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005794int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5795 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5796 int cert_endpoint,
5797 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005798{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005799 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005800 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005801 const char *ext_oid;
5802 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005803
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005805 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005807 case MBEDTLS_KEY_EXCHANGE_RSA:
5808 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005809 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005810 break;
5811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5813 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5814 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5815 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005816 break;
5817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5819 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005820 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005821 break;
5822
5823 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005824 case MBEDTLS_KEY_EXCHANGE_NONE:
5825 case MBEDTLS_KEY_EXCHANGE_PSK:
5826 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5827 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005828 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005829 usage = 0;
5830 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005832 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5833 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005834 }
5835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005837 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005838 ret = -1;
5839 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005842 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5844 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005845 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005847 }
5848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005850 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005851 ret = -1;
5852 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005855}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005856#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005857
Jerry Yu148165c2021-09-24 23:20:59 +08005858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005859int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5860 const mbedtls_md_type_t md,
5861 unsigned char *dst,
5862 size_t dst_len,
5863 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005864{
Ronald Cronf6893e12022-01-07 22:09:01 +01005865 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5866 psa_hash_operation_t *hash_operation_to_clone;
5867 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5868
Jerry Yu148165c2021-09-24 23:20:59 +08005869 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005870
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 case MBEDTLS_MD_SHA384:
5874 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5875 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005876#endif
5877
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005878#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 case MBEDTLS_MD_SHA256:
5880 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5881 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005882#endif
5883
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 default:
5885 goto exit;
5886 }
5887
5888 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5889 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005890 goto exit;
5891 }
5892
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5894 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005895 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005897
5898exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005899#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5900 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005901 (void) ssl;
5902#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005903 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005904}
5905#else /* MBEDTLS_USE_PSA_CRYPTO */
5906
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005907#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005908MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005909static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5910 unsigned char *dst,
5911 size_t dst_len,
5912 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005913{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005914 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005915 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005916
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 if (dst_len < 48) {
5918 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5919 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005920
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005921 mbedtls_md_init(&sha384);
5922 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005923 if (ret != 0) {
5924 goto exit;
5925 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005926 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005927 if (ret != 0) {
5928 goto exit;
5929 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005930
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005931 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005932 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005933 goto exit;
5934 }
5935
5936 *olen = 48;
5937
5938exit:
5939
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005940 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005942}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005943#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005944
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005945#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005946MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005947static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5948 unsigned char *dst,
5949 size_t dst_len,
5950 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005951{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005952 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005953 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005954
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 if (dst_len < 32) {
5956 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5957 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005958
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005959 mbedtls_md_init(&sha256);
5960 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5961 if (ret != 0) {
5962 goto exit;
5963 }
5964 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5965 if (ret != 0) {
5966 goto exit;
5967 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005968
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005969 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5970 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005971 goto exit;
5972 }
5973
5974 *olen = 32;
5975
5976exit:
5977
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005978 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005980}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005981#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5984 const mbedtls_md_type_t md,
5985 unsigned char *dst,
5986 size_t dst_len,
5987 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005988{
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005990
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005991#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 case MBEDTLS_MD_SHA384:
5993 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005994#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005995
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005996#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 case MBEDTLS_MD_SHA256:
5998 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005999#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006002#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6003 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 (void) ssl;
6005 (void) dst;
6006 (void) dst_len;
6007 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006008#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006010 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006012}
XiaokangQian647719a2021-12-07 09:16:29 +00006013
Jerry Yu148165c2021-09-24 23:20:59 +08006014#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006015
Ronald Crone68ab4f2022-10-05 12:46:29 +02006016#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006017/* mbedtls_ssl_parse_sig_alg_ext()
6018 *
6019 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6020 * value (TLS 1.3 RFC8446):
6021 * enum {
6022 * ....
6023 * ecdsa_secp256r1_sha256( 0x0403 ),
6024 * ecdsa_secp384r1_sha384( 0x0503 ),
6025 * ecdsa_secp521r1_sha512( 0x0603 ),
6026 * ....
6027 * } SignatureScheme;
6028 *
6029 * struct {
6030 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6031 * } SignatureSchemeList;
6032 *
6033 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6034 * value (TLS 1.2 RFC5246):
6035 * enum {
6036 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6037 * sha512(6), (255)
6038 * } HashAlgorithm;
6039 *
6040 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6041 * SignatureAlgorithm;
6042 *
6043 * struct {
6044 * HashAlgorithm hash;
6045 * SignatureAlgorithm signature;
6046 * } SignatureAndHashAlgorithm;
6047 *
6048 * SignatureAndHashAlgorithm
6049 * supported_signature_algorithms<2..2^16-2>;
6050 *
6051 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6052 * generalization of the TLS 1.2 signature algorithm extension.
6053 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6054 * `SignatureScheme` field of TLS 1.3
6055 *
6056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006057int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6058 const unsigned char *buf,
6059 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006060{
6061 const unsigned char *p = buf;
6062 size_t supported_sig_algs_len = 0;
6063 const unsigned char *supported_sig_algs_end;
6064 uint16_t sig_alg;
6065 uint32_t common_idx = 0;
6066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6068 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006069 p += 2;
6070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 memset(ssl->handshake->received_sig_algs, 0,
6072 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006075 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 while (p < supported_sig_algs_end) {
6077 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6078 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006079 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6081 sig_alg,
6082 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006083#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6085 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6086 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006087 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006088 }
6089#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006090
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6092 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006095 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6096 common_idx += 1;
6097 }
6098 }
6099 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (p != end) {
6101 MBEDTLS_SSL_DEBUG_MSG(1,
6102 ("Signature algorithms extension length misaligned"));
6103 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6104 MBEDTLS_ERR_SSL_DECODE_ERROR);
6105 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006106 }
6107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (common_idx == 0) {
6109 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6110 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6111 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6112 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006113 }
6114
Gabor Mezei15b95a62022-05-09 16:37:58 +02006115 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006117}
6118
Ronald Crone68ab4f2022-10-05 12:46:29 +02006119#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006120
Jerry Yudc7bd172022-02-17 13:44:15 +08006121#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6122
6123#if defined(MBEDTLS_USE_PSA_CRYPTO)
6124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6126 mbedtls_svc_key_id_t key,
6127 psa_algorithm_t alg,
6128 const unsigned char *raw_psk, size_t raw_psk_length,
6129 const unsigned char *seed, size_t seed_length,
6130 const unsigned char *label, size_t label_length,
6131 const unsigned char *other_secret,
6132 size_t other_secret_length,
6133 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006134{
6135 psa_status_t status;
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 status = psa_key_derivation_setup(derivation, alg);
6138 if (status != PSA_SUCCESS) {
6139 return status;
6140 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006141
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6143 status = psa_key_derivation_input_bytes(derivation,
6144 PSA_KEY_DERIVATION_INPUT_SEED,
6145 seed, seed_length);
6146 if (status != PSA_SUCCESS) {
6147 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006148 }
6149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 if (other_secret != NULL) {
6151 status = psa_key_derivation_input_bytes(derivation,
6152 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6153 other_secret, other_secret_length);
6154 if (status != PSA_SUCCESS) {
6155 return status;
6156 }
6157 }
6158
6159 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006160 status = psa_key_derivation_input_bytes(
6161 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 raw_psk, raw_psk_length);
6163 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006164 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006166 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 if (status != PSA_SUCCESS) {
6168 return status;
6169 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 status = psa_key_derivation_input_bytes(derivation,
6172 PSA_KEY_DERIVATION_INPUT_LABEL,
6173 label, label_length);
6174 if (status != PSA_SUCCESS) {
6175 return status;
6176 }
6177 } else {
6178 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006179 }
6180
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 status = psa_key_derivation_set_capacity(derivation, capacity);
6182 if (status != PSA_SUCCESS) {
6183 return status;
6184 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006187}
6188
Andrzej Kurek57d10632022-10-24 10:32:01 -04006189#if defined(PSA_WANT_ALG_SHA_384) || \
6190 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006192static int tls_prf_generic(mbedtls_md_type_t md_type,
6193 const unsigned char *secret, size_t slen,
6194 const char *label,
6195 const unsigned char *random, size_t rlen,
6196 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006197{
6198 psa_status_t status;
6199 psa_algorithm_t alg;
6200 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6201 psa_key_derivation_operation_t derivation =
6202 PSA_KEY_DERIVATION_OPERATION_INIT;
6203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006205 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006209
6210 /* Normally a "secret" should be long enough to be impossible to
6211 * find by brute force, and in particular should not be empty. But
6212 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6213 * and for this use case it makes sense to have a 0-length "secret".
6214 * Since the key API doesn't allow importing a key of length 0,
6215 * keep master_key=0, which setup_psa_key_derivation() understands
6216 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006218 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6220 psa_set_key_algorithm(&key_attributes, alg);
6221 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6224 if (status != PSA_SUCCESS) {
6225 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6226 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006227 }
6228
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 status = setup_psa_key_derivation(&derivation,
6230 master_key, alg,
6231 NULL, 0,
6232 random, rlen,
6233 (unsigned char const *) label,
6234 (size_t) strlen(label),
6235 NULL, 0,
6236 dlen);
6237 if (status != PSA_SUCCESS) {
6238 psa_key_derivation_abort(&derivation);
6239 psa_destroy_key(master_key);
6240 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 }
6242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6244 if (status != PSA_SUCCESS) {
6245 psa_key_derivation_abort(&derivation);
6246 psa_destroy_key(master_key);
6247 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006248 }
6249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 status = psa_key_derivation_abort(&derivation);
6251 if (status != PSA_SUCCESS) {
6252 psa_destroy_key(master_key);
6253 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 }
6255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if (!mbedtls_svc_key_id_is_null(master_key)) {
6257 status = psa_destroy_key(master_key);
6258 }
6259 if (status != PSA_SUCCESS) {
6260 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6261 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006264}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006265#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006266#else /* MBEDTLS_USE_PSA_CRYPTO */
6267
Andrzej Kurek57d10632022-10-24 10:32:01 -04006268#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006269 (defined(MBEDTLS_MD_CAN_SHA256) || \
6270 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006272static int tls_prf_generic(mbedtls_md_type_t md_type,
6273 const unsigned char *secret, size_t slen,
6274 const char *label,
6275 const unsigned char *random, size_t rlen,
6276 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006277{
6278 size_t nb;
6279 size_t i, j, k, md_len;
6280 unsigned char *tmp;
6281 size_t tmp_len = 0;
6282 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6283 const mbedtls_md_info_t *md_info;
6284 mbedtls_md_context_t md_ctx;
6285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6290 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6291 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006292
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 tmp_len = md_len + strlen(label) + rlen;
6296 tmp = mbedtls_calloc(1, tmp_len);
6297 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006298 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6299 goto exit;
6300 }
6301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 nb = strlen(label);
6303 memcpy(tmp + md_len, label, nb);
6304 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006305 nb += rlen;
6306
6307 /*
6308 * Compute P_<hash>(secret, label + random)[0..dlen]
6309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006311 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6315 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006316 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 }
6318 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6319 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006320 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 }
6322 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6323 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006324 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 for (i = 0; i < dlen; i += md_len) {
6328 ret = mbedtls_md_hmac_reset(&md_ctx);
6329 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006330 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 }
6332 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6333 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006334 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 }
6336 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6337 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006338 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006340
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 ret = mbedtls_md_hmac_reset(&md_ctx);
6342 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 }
6345 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6346 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006347 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 }
6349 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6350 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006351 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006355
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006357 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006359 }
6360
6361exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006363
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 if (tmp != NULL) {
6365 mbedtls_platform_zeroize(tmp, tmp_len);
6366 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006367
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006373}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006374#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006375#endif /* MBEDTLS_USE_PSA_CRYPTO */
6376
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006377#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006378MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006379static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6380 const char *label,
6381 const unsigned char *random, size_t rlen,
6382 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006383{
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6385 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006386}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006387#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006388
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006389#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006390MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006391static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6392 const char *label,
6393 const unsigned char *random, size_t rlen,
6394 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006395{
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6397 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006398}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006399#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006400
Jerry Yuf009d862022-02-17 14:01:37 +08006401/*
6402 * Set appropriate PRF function and other SSL / TLS1.2 functions
6403 *
6404 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006405 * - hash associated with the ciphersuite (only used by TLS 1.2)
6406 *
6407 * Outputs:
6408 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6409 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006410MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006411static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6412 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006413{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006414#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006416 handshake->tls_prf = tls_prf_sha384;
6417 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6418 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006420#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006421#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006422 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006423 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006424 handshake->tls_prf = tls_prf_sha256;
6425 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6426 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6427 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006428#else
Jerry Yuf009d862022-02-17 14:01:37 +08006429 {
Jerry Yuf009d862022-02-17 14:01:37 +08006430 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006431 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006433 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006434#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006437}
Jerry Yud6ab2352022-02-17 14:03:43 +08006438
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006439/*
6440 * Compute master secret if needed
6441 *
6442 * Parameters:
6443 * [in/out] handshake
6444 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6445 * (PSA-PSK) ciphersuite_info, psk_opaque
6446 * [out] premaster (cleared)
6447 * [out] master
6448 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6449 * debug: conf->f_dbg, conf->p_dbg
6450 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006451 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006452 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006453MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006454static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6455 unsigned char *master,
6456 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006457{
6458 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6459
6460 /* cf. RFC 5246, Section 8.1:
6461 * "The master secret is always exactly 48 bytes in length." */
6462 size_t const master_secret_len = 48;
6463
6464#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6465 unsigned char session_hash[48];
6466#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6467
6468 /* The label for the KDF used for key expansion.
6469 * This is either "master secret" or "extended master secret"
6470 * depending on whether the Extended Master Secret extension
6471 * is used. */
6472 char const *lbl = "master secret";
6473
Przemek Stekielae4ed302022-04-05 17:15:55 +02006474 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475 * - If the Extended Master Secret extension is not used,
6476 * this is ClientHello.Random + ServerHello.Random
6477 * (see Sect. 8.1 in RFC 5246).
6478 * - If the Extended Master Secret extension is used,
6479 * this is the transcript of the handshake so far.
6480 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006481 unsigned char const *seed = handshake->randbytes;
6482 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006483
6484#if !defined(MBEDTLS_DEBUG_C) && \
6485 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6486 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006488 ssl = NULL; /* make sure we don't use it except for those cases */
6489 (void) ssl;
6490#endif
6491
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 if (handshake->resume != 0) {
6493 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6494 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006495 }
6496
6497#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006499 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006500 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006501 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6502 if (ret != 0) {
6503 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6504 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6507 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006508 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006509#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006510
Przemek Stekiel99114f32022-04-22 11:20:09 +02006511#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006512 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006514 /* Perform PSK-to-MS expansion in a single step. */
6515 psa_status_t status;
6516 psa_algorithm_t alg;
6517 mbedtls_svc_key_id_t psk;
6518 psa_key_derivation_operation_t derivation =
6519 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006520 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006527 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006531
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006532 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006536 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006537 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006538 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006539 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006540 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006541 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006542 other_secret_len = 48;
6543 other_secret = handshake->premaster + 2;
6544 break;
6545 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006546 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006547 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6548 other_secret = handshake->premaster + 2;
6549 break;
6550 default:
6551 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006552 }
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 status = setup_psa_key_derivation(&derivation, psk, alg,
6555 ssl->conf->psk, ssl->conf->psk_len,
6556 seed, seed_len,
6557 (unsigned char const *) lbl,
6558 (size_t) strlen(lbl),
6559 other_secret, other_secret_len,
6560 master_secret_len);
6561 if (status != PSA_SUCCESS) {
6562 psa_key_derivation_abort(&derivation);
6563 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006564 }
6565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 status = psa_key_derivation_output_bytes(&derivation,
6567 master,
6568 master_secret_len);
6569 if (status != PSA_SUCCESS) {
6570 psa_key_derivation_abort(&derivation);
6571 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006572 }
6573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 status = psa_key_derivation_abort(&derivation);
6575 if (status != PSA_SUCCESS) {
6576 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6577 }
6578 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006579#endif
6580 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006581#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6583 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006584 psa_status_t status;
6585 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6586 psa_key_derivation_operation_t derivation =
6587 PSA_KEY_DERIVATION_OPERATION_INIT;
6588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006590
6591 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 status = psa_key_derivation_setup(&derivation, alg);
6594 if (status != PSA_SUCCESS) {
6595 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006596 }
6597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 status = psa_key_derivation_set_capacity(&derivation,
6599 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6600 if (status != PSA_SUCCESS) {
6601 psa_key_derivation_abort(&derivation);
6602 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006603 }
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6606 &derivation);
6607 if (status != PSA_SUCCESS) {
6608 psa_key_derivation_abort(&derivation);
6609 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006610 }
6611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 status = psa_key_derivation_output_bytes(&derivation,
6613 handshake->premaster,
6614 handshake->pmslen);
6615 if (status != PSA_SUCCESS) {
6616 psa_key_derivation_abort(&derivation);
6617 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6618 }
6619
6620 status = psa_key_derivation_abort(&derivation);
6621 if (status != PSA_SUCCESS) {
6622 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006623 }
6624 }
6625#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6627 lbl, seed, seed_len,
6628 master,
6629 master_secret_len);
6630 if (ret != 0) {
6631 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6632 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006633 }
6634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6636 handshake->premaster,
6637 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 mbedtls_platform_zeroize(handshake->premaster,
6640 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006641 }
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006644}
6645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006647{
6648 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6649 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6650 ssl->handshake->ciphersuite_info;
6651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006653
6654 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006656 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 if (ret != 0) {
6658 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6659 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006660 }
6661
6662 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 ret = ssl_compute_master(ssl->handshake,
6664 ssl->session_negotiate->master,
6665 ssl);
6666 if (ret != 0) {
6667 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6668 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006669 }
6670
6671 /* Swap the client and server random values:
6672 * - MS derivation wanted client+server (RFC 5246 8.1)
6673 * - key derivation wants server+client (RFC 5246 6.3) */
6674 {
6675 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 memcpy(tmp, ssl->handshake->randbytes, 64);
6677 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6678 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6679 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006680 }
6681
6682 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6684 ssl->session_negotiate->ciphersuite,
6685 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006686#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006688#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 ssl->handshake->tls_prf,
6690 ssl->handshake->randbytes,
6691 ssl->tls_version,
6692 ssl->conf->endpoint,
6693 ssl);
6694 if (ret != 0) {
6695 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6696 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006697 }
6698
6699 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6701 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006706}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006709{
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006711#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006712 case MBEDTLS_SSL_HASH_SHA384:
6713 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6714 break;
6715#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006716#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006717 case MBEDTLS_SSL_HASH_SHA256:
6718 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6719 break;
6720#endif
6721 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006723 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006724#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6725 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006726 (void) ssl;
6727#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006729}
6730
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006731#if defined(MBEDTLS_USE_PSA_CRYPTO)
6732static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6733 const psa_hash_operation_t *hs_op,
6734 size_t buffer_size,
6735 unsigned char *hash,
6736 size_t *hlen)
6737{
6738 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006739 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006740
6741#if !defined(MBEDTLS_DEBUG_C)
6742 (void) ssl;
6743#endif
6744 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006745 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006746 if (status != PSA_SUCCESS) {
6747 goto exit;
6748 }
6749
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006750 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006751 if (status != PSA_SUCCESS) {
6752 goto exit;
6753 }
6754
6755 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6756 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6757
6758exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006759 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006760 return mbedtls_md_error_from_psa(status);
6761}
6762#else
6763static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6764 const mbedtls_md_context_t *hs_ctx,
6765 unsigned char *hash,
6766 size_t *hlen)
6767{
6768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006769 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006770
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006771 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006772
6773#if !defined(MBEDTLS_DEBUG_C)
6774 (void) ssl;
6775#endif
6776 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6777
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006778 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006779 if (ret != 0) {
6780 goto exit;
6781 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006782 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006783 if (ret != 0) {
6784 goto exit;
6785 }
6786
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006787 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006788 if (ret != 0) {
6789 goto exit;
6790 }
6791
6792 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6793
6794 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6795 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6796
6797exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006798 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006799 return ret;
6800}
6801#endif /* MBEDTLS_USE_PSA_CRYPTO */
6802
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006803#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006804int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6805 unsigned char *hash,
6806 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006807{
6808#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006809 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6810 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006811#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006812 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6813 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006814#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006815}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006816#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006817
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006818#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006819int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6820 unsigned char *hash,
6821 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006822{
6823#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006824 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6825 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006826#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006827 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6828 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006829#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006830}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006831#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006832
Neil Armstrong80f6f322022-05-03 17:56:38 +02006833#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6834 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006835int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006836{
6837 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006839 const unsigned char *psk = NULL;
6840 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006844 /*
6845 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006846 * checked before calling this function.
6847 *
6848 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006849 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6852 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6853 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006854 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006855 }
6856
6857 /*
6858 * PMS = struct {
6859 * opaque other_secret<0..2^16-1>;
6860 * opaque psk<0..2^16-1>;
6861 * };
6862 * with "other_secret" depending on the particular key exchange
6863 */
6864#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6866 if (end - p < 2) {
6867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6868 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006871 p += 2;
6872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if (end < p || (size_t) (end - p) < psk_len) {
6874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6875 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006878 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006880#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6881#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006883 /*
6884 * other_secret already set by the ClientKeyExchange message,
6885 * and is 48 bytes long
6886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (end - p < 2) {
6888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6889 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006890
6891 *p++ = 0;
6892 *p++ = 48;
6893 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006895#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6896#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006898 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6899 size_t len;
6900
6901 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006903 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6906 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006907 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006909 p += 2 + len;
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6912 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006913#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006914#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6917 size_t zlen;
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006920 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6922 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6923 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006924 }
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006927 p += 2 + zlen;
6928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6930 MBEDTLS_DEBUG_ECDH_Z);
6931 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006932#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006933 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6935 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006936 }
6937
6938 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 if (end - p < 2) {
6940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6941 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006944 p += 2;
6945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 if (end < p || (size_t) (end - p) < psk_len) {
6947 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6948 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006951 p += psk_len;
6952
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006953 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006954
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006956}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006957#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006958
6959#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006961static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006962
6963#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006964int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006965{
6966 /* If renegotiation is not enforced, retransmit until we would reach max
6967 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006969 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6970 unsigned char doublings = 1;
6971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006973 ++doublings;
6974 ratio >>= 1;
6975 }
6976
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (++ssl->renego_records_seen > doublings) {
6978 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6979 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006980 }
6981 }
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006984}
6985#endif
6986#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006987
Jerry Yud9526692022-02-17 14:23:47 +08006988/*
6989 * Handshake functions
6990 */
6991#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6992/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006993int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006994{
6995 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6996 ssl->handshake->ciphersuite_info;
6997
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7001 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007002 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007004 }
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7007 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007008}
7009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007011{
7012 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7013 ssl->handshake->ciphersuite_info;
7014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7018 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007019 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007021 }
7022
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7024 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007025}
7026
7027#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7028/* Some certificate support -> implement write and parse */
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007031{
7032 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7033 size_t i, n;
7034 const mbedtls_x509_crt *crt;
7035 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7036 ssl->handshake->ciphersuite_info;
7037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007039
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7041 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007042 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007044 }
7045
7046#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7048 if (ssl->handshake->client_auth == 0) {
7049 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007050 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007052 }
7053 }
7054#endif /* MBEDTLS_SSL_CLI_C */
7055#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7057 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007058 /* Should never happen because we shouldn't have picked the
7059 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007061 }
7062 }
7063#endif
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007066
7067 /*
7068 * 0 . 0 handshake type
7069 * 1 . 3 handshake length
7070 * 4 . 6 length of all certs
7071 * 7 . 9 length of cert. 1
7072 * 10 . n-1 peer certificate
7073 * n . n+2 length of cert. 2
7074 * n+3 . ... upper level cert, etc.
7075 */
7076 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007080 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7082 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7083 " > %" MBEDTLS_PRINTF_SIZET,
7084 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7085 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007086 }
7087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7089 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7090 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007091
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007093 i += n; crt = crt->next;
7094 }
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7097 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7098 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007099
7100 ssl->out_msglen = i;
7101 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7102 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7103
7104 ssl->state++;
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7107 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7108 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007109 }
7110
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007114}
7115
7116#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7117
7118#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007119MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007120static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7121 unsigned char *crt_buf,
7122 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007123{
7124 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (peer_crt == NULL) {
7127 return -1;
7128 }
Jerry Yud9526692022-02-17 14:23:47 +08007129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 if (peer_crt->raw.len != crt_buf_len) {
7131 return -1;
7132 }
Jerry Yud9526692022-02-17 14:23:47 +08007133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007135}
7136#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007138static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7139 unsigned char *crt_buf,
7140 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007141{
7142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7143 unsigned char const * const peer_cert_digest =
7144 ssl->session->peer_cert_digest;
7145 mbedtls_md_type_t const peer_cert_digest_type =
7146 ssl->session->peer_cert_digest_type;
7147 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007149 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7150 size_t digest_len;
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 if (peer_cert_digest == NULL || digest_info == NULL) {
7153 return -1;
7154 }
Jerry Yud9526692022-02-17 14:23:47 +08007155
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 digest_len = mbedtls_md_get_size(digest_info);
7157 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7158 return -1;
7159 }
Jerry Yud9526692022-02-17 14:23:47 +08007160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7162 if (ret != 0) {
7163 return -1;
7164 }
Jerry Yud9526692022-02-17 14:23:47 +08007165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007167}
7168#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7169#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7170
7171/*
7172 * Once the certificate message is read, parse it into a cert chain and
7173 * perform basic checks, but leave actual verification to the caller
7174 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007175MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007176static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7177 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007178{
7179 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7180#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007182#endif
7183 size_t i, n;
7184 uint8_t alert;
7185
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7187 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7188 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7189 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7190 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007191 }
7192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7194 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7195 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7196 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007197 }
7198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7200 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7201 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7202 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7203 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007204 }
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007207
7208 /*
7209 * Same message structure as in mbedtls_ssl_write_certificate()
7210 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007211 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007212
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 if (ssl->in_msg[i] != 0 ||
7214 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7215 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7216 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7217 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7218 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007219 }
7220
7221 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7222 i += 3;
7223
7224 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007226 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (i + 3 > ssl->in_hslen) {
7228 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7229 mbedtls_ssl_send_alert_message(ssl,
7230 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7231 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7232 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007233 }
7234 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7235 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 if (ssl->in_msg[i] != 0) {
7237 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7238 mbedtls_ssl_send_alert_message(ssl,
7239 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7240 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7241 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007242 }
7243
7244 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007245 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007246 i += 3;
7247
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 if (n < 128 || i + n > ssl->in_hslen) {
7249 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7250 mbedtls_ssl_send_alert_message(ssl,
7251 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7252 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7253 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007254 }
7255
7256 /* Check if we're handling the first CRT in the chain. */
7257#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007259 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007261 /* During client-side renegotiation, check that the server's
7262 * end-CRTs hasn't changed compared to the initial handshake,
7263 * mitigating the triple handshake attack. On success, reuse
7264 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7266 if (ssl_check_peer_crt_unchanged(ssl,
7267 &ssl->in_msg[i],
7268 n) != 0) {
7269 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7270 mbedtls_ssl_send_alert_message(ssl,
7271 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7272 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7273 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007274 }
7275
7276 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007278 }
7279#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7280
7281 /* Parse the next certificate in the chain. */
7282#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007284#else
7285 /* If we don't need to store the CRT chain permanently, parse
7286 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007288#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007290 case 0: /*ok*/
7291 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7292 /* Ignore certificate with an unknown algorithm: maybe a
7293 prior certificate was already trusted. */
7294 break;
7295
7296 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7297 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7298 goto crt_parse_der_failed;
7299
7300 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7301 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7302 goto crt_parse_der_failed;
7303
7304 default:
7305 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007306crt_parse_der_failed:
7307 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7308 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7309 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007310 }
7311
7312 i += n;
7313 }
7314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7316 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007317}
7318
7319#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007321static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007322{
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7324 return -1;
7325 }
Jerry Yud9526692022-02-17 14:23:47 +08007326
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007328 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7329 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7331 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7332 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007333 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007335}
7336#endif /* MBEDTLS_SSL_SRV_C */
7337
7338/* Check if a certificate message is expected.
7339 * Return either
7340 * - SSL_CERTIFICATE_EXPECTED, or
7341 * - SSL_CERTIFICATE_SKIP
7342 * indicating whether a Certificate message is expected or not.
7343 */
7344#define SSL_CERTIFICATE_EXPECTED 0
7345#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007346MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007347static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7348 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007349{
7350 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7351 ssl->handshake->ciphersuite_info;
7352
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7354 return SSL_CERTIFICATE_SKIP;
7355 }
Jerry Yud9526692022-02-17 14:23:47 +08007356
7357#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7359 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7360 return SSL_CERTIFICATE_SKIP;
7361 }
Jerry Yud9526692022-02-17 14:23:47 +08007362
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007364 ssl->session_negotiate->verify_result =
7365 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007367 }
7368 }
7369#else
7370 ((void) authmode);
7371#endif /* MBEDTLS_SSL_SRV_C */
7372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007374}
7375
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007376MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007377static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7378 int authmode,
7379 mbedtls_x509_crt *chain,
7380 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007381{
7382 int ret = 0;
7383 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7384 ssl->handshake->ciphersuite_info;
7385 int have_ca_chain = 0;
7386
7387 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7388 void *p_vrfy;
7389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7391 return 0;
7392 }
Jerry Yud9526692022-02-17 14:23:47 +08007393
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (ssl->f_vrfy != NULL) {
7395 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007396 f_vrfy = ssl->f_vrfy;
7397 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 } else {
7399 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007400 f_vrfy = ssl->conf->f_vrfy;
7401 p_vrfy = ssl->conf->p_vrfy;
7402 }
7403
7404 /*
7405 * Main check: verify certificate
7406 */
7407#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 ((void) rs_ctx);
7410 have_ca_chain = 1;
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007413 ret = mbedtls_x509_crt_verify_with_ca_cb(
7414 chain,
7415 ssl->conf->f_ca_cb,
7416 ssl->conf->p_ca_cb,
7417 ssl->conf->cert_profile,
7418 ssl->hostname,
7419 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 f_vrfy, p_vrfy);
7421 } else
Jerry Yud9526692022-02-17 14:23:47 +08007422#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7423 {
7424 mbedtls_x509_crt *ca_chain;
7425 mbedtls_x509_crl *ca_crl;
7426
7427#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007429 ca_chain = ssl->handshake->sni_ca_chain;
7430 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 } else
Jerry Yud9526692022-02-17 14:23:47 +08007432#endif
7433 {
7434 ca_chain = ssl->conf->ca_chain;
7435 ca_crl = ssl->conf->ca_crl;
7436 }
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007439 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 }
Jerry Yud9526692022-02-17 14:23:47 +08007441
7442 ret = mbedtls_x509_crt_verify_restartable(
7443 chain,
7444 ca_chain, ca_crl,
7445 ssl->conf->cert_profile,
7446 ssl->hostname,
7447 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007449 }
7450
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (ret != 0) {
7452 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007453 }
7454
7455#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7457 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7458 }
Jerry Yud9526692022-02-17 14:23:47 +08007459#endif
7460
7461 /*
7462 * Secondary checks: always done, but change 'ret' only if it was 0
7463 */
7464
Valerio Settiacd32c02023-06-29 18:06:29 +02007465#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007466 {
7467 const mbedtls_pk_context *pk = &chain->pk;
7468
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007469 /* If certificate uses an EC key, make sure the curve is OK.
7470 * This is a public key, so it can't be opaque, so can_do() is a good
7471 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007473 /* and in the unlikely case the above assumption no longer holds
7474 * we are making sure that pk_ec() here does not return a NULL
7475 */
Valerio Settif9362b72023-11-29 08:42:27 +01007476 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007477 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7478 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007480 }
Valerio Setti97207782023-05-18 18:59:06 +02007481 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007482 ssl->session_negotiate->verify_result |=
7483 MBEDTLS_X509_BADCERT_BAD_KEY;
7484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7486 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007487 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007489 }
Jerry Yud9526692022-02-17 14:23:47 +08007490 }
7491 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007492#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (mbedtls_ssl_check_cert_usage(chain,
7495 ciphersuite_info,
7496 !ssl->conf->endpoint,
7497 &ssl->session_negotiate->verify_result) != 0) {
7498 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7499 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007500 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 }
Jerry Yud9526692022-02-17 14:23:47 +08007502 }
7503
7504 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7505 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7506 * with details encoded in the verification flags. All other kinds
7507 * of error codes, including those from the user provided f_vrfy
7508 * functions, are treated as fatal and lead to a failure of
7509 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7511 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7512 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007513 ret = 0;
7514 }
7515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7517 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007518 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7519 }
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007522 uint8_t alert;
7523
7524 /* The certificate may have been rejected for several reasons.
7525 Pick one and send the corresponding alert. Which alert to send
7526 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007528 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007530 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007532 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007534 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007536 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007538 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007540 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007542 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007544 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007546 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007548 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 }
7550 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7551 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007552 }
7553
7554#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (ssl->session_negotiate->verify_result != 0) {
7556 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7557 (unsigned int) ssl->session_negotiate->verify_result));
7558 } else {
7559 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007560 }
7561#endif /* MBEDTLS_DEBUG_C */
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007564}
7565
7566#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007567MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007568static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7569 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007570{
7571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7572 /* Remember digest of the peer's end-CRT. */
7573 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7575 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7576 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7577 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7578 mbedtls_ssl_send_alert_message(ssl,
7579 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7580 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007583 }
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 ret = mbedtls_md(mbedtls_md_info_from_type(
7586 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7587 start, len,
7588 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007589
7590 ssl->session_negotiate->peer_cert_digest_type =
7591 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7592 ssl->session_negotiate->peer_cert_digest_len =
7593 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007596}
7597
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007598MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007599static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7600 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007601{
7602 unsigned char *end = start + len;
7603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7604
7605 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7607 ret = mbedtls_pk_parse_subpubkey(&start, end,
7608 &ssl->handshake->peer_pubkey);
7609 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007610 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007612 }
7613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007615}
7616#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007619{
7620 int ret = 0;
7621 int crt_expected;
7622#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7623 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7624 ? ssl->handshake->sni_authmode
7625 : ssl->conf->authmode;
7626#else
7627 const int authmode = ssl->conf->authmode;
7628#endif
7629 void *rs_ctx = NULL;
7630 mbedtls_x509_crt *chain = NULL;
7631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7635 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7636 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007637 goto exit;
7638 }
7639
7640#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if (ssl->handshake->ecrs_enabled &&
7642 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007643 chain = ssl->handshake->ecrs_peer_cert;
7644 ssl->handshake->ecrs_peer_cert = NULL;
7645 goto crt_verify;
7646 }
7647#endif
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007650 /* mbedtls_ssl_read_record may have sent an alert already. We
7651 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007653 goto exit;
7654 }
7655
7656#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007658 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007661 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 }
Jerry Yud9526692022-02-17 14:23:47 +08007663
7664 goto exit;
7665 }
7666#endif /* MBEDTLS_SSL_SRV_C */
7667
7668 /* Clear existing peer CRT structure in case we tried to
7669 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7673 if (chain == NULL) {
7674 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7675 sizeof(mbedtls_x509_crt)));
7676 mbedtls_ssl_send_alert_message(ssl,
7677 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7678 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007679
7680 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7681 goto exit;
7682 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007684
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 ret = ssl_parse_certificate_chain(ssl, chain);
7686 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007687 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 }
Jerry Yud9526692022-02-17 14:23:47 +08007689
7690#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007692 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 }
Jerry Yud9526692022-02-17 14:23:47 +08007694
7695crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007697 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 }
Jerry Yud9526692022-02-17 14:23:47 +08007699#endif
7700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 ret = ssl_parse_certificate_verify(ssl, authmode,
7702 chain, rs_ctx);
7703 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007704 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 }
Jerry Yud9526692022-02-17 14:23:47 +08007706
7707#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7708 {
7709 unsigned char *crt_start, *pk_start;
7710 size_t crt_len, pk_len;
7711
7712 /* We parse the CRT chain without copying, so
7713 * these pointers point into the input buffer,
7714 * and are hence still valid after freeing the
7715 * CRT chain. */
7716
7717 crt_start = chain->raw.p;
7718 crt_len = chain->raw.len;
7719
7720 pk_start = chain->pk_raw.p;
7721 pk_len = chain->pk_raw.len;
7722
7723 /* Free the CRT structures before computing
7724 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 mbedtls_x509_crt_free(chain);
7726 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007727 chain = NULL;
7728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7730 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007731 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 }
Jerry Yud9526692022-02-17 14:23:47 +08007733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7735 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007736 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 }
Jerry Yud9526692022-02-17 14:23:47 +08007738 }
7739#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7740 /* Pass ownership to session structure. */
7741 ssl->session_negotiate->peer_cert = chain;
7742 chain = NULL;
7743#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7744
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007746
7747exit:
7748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007750 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 }
Jerry Yud9526692022-02-17 14:23:47 +08007752
7753#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007755 ssl->handshake->ecrs_peer_cert = chain;
7756 chain = NULL;
7757 }
7758#endif
7759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 if (chain != NULL) {
7761 mbedtls_x509_crt_free(chain);
7762 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007763 }
7764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007766}
7767#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7768
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007769static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7770 unsigned char *padbuf, size_t hlen,
7771 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007772{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007773 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007774 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007775#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007776 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007777 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007778 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007779 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007780#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007782 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007783 mbedtls_md_context_t cloned_ctx;
7784 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007785#endif
7786
7787 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007789 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007791
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007793 ? "client finished"
7794 : "server finished";
7795
7796#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007797 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007798
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007799 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007801 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007802 }
7803
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007804 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007806 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007807 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007808 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007809#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007810 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007811
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007812 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007813 if (ret != 0) {
7814 goto exit;
7815 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007816 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007817 if (ret != 0) {
7818 goto exit;
7819 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007820
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007821 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007822 if (ret != 0) {
7823 goto exit;
7824 }
7825#endif /* MBEDTLS_USE_PSA_CRYPTO */
7826
7827 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7828
Jerry Yu615bd6f2022-02-17 14:25:15 +08007829 /*
7830 * TLSv1.2:
7831 * hash = PRF( master, finished_label,
7832 * Hash( handshake ) )[0.11]
7833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007835 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007836
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007838
Paul Elliottecb95be2023-08-11 16:41:04 +01007839 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007840
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007841 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007842
7843exit:
7844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007845 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007847#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007848 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007849 return ret;
7850#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007851}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007852
7853#if defined(MBEDTLS_MD_CAN_SHA256)
7854static int ssl_calc_finished_tls_sha256(
7855 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7856{
7857 unsigned char padbuf[32];
7858 return ssl_calc_finished_tls_generic(ssl,
7859#if defined(MBEDTLS_USE_PSA_CRYPTO)
7860 &ssl->handshake->fin_sha256_psa,
7861#else
7862 &ssl->handshake->fin_sha256,
7863#endif
7864 padbuf, sizeof(padbuf),
7865 buf, from);
7866}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007867#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007868
Jerry Yub7ba49e2022-02-17 14:25:53 +08007869
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007870#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007871static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007873{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007874 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007875 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007876#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007877 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007878#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007879 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007880#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007881 padbuf, sizeof(padbuf),
7882 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007883}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007884#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007885
Gilles Peskine449bd832023-01-11 14:50:10 +01007886void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007887{
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007889
7890 /*
7891 * Free our handshake params
7892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 mbedtls_ssl_handshake_free(ssl);
7894 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007895 ssl->handshake = NULL;
7896
7897 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007898 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 if (ssl->transform) {
7901 mbedtls_ssl_transform_free(ssl->transform);
7902 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007903 }
7904 ssl->transform = ssl->transform_negotiate;
7905 ssl->transform_negotiate = NULL;
7906
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007908}
7909
Gilles Peskine449bd832023-01-11 14:50:10 +01007910void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911{
7912 int resume = ssl->handshake->resume;
7913
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007915
7916#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007918 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7919 ssl->renego_records_seen = 0;
7920 }
7921#endif
7922
7923 /*
7924 * Free the previous session and switch in the current one
7925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7928 /* RFC 7366 3.1: keep the EtM state */
7929 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007931#endif
7932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 mbedtls_ssl_session_free(ssl->session);
7934 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007935 }
7936 ssl->session = ssl->session_negotiate;
7937 ssl->session_negotiate = NULL;
7938
7939 /*
7940 * Add cache entry
7941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007943 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 resume == 0) {
7945 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7946 ssl->session->id,
7947 ssl->session->id_len,
7948 ssl->session) != 0) {
7949 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7950 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007951 }
7952
7953#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7955 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007956 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007958
7959 /* Keep last flight around in case we need to resend it:
7960 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7962 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007963#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007965
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007966 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007967
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007969}
7970
Gilles Peskine449bd832023-01-11 14:50:10 +01007971int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007972{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007973 int ret;
7974 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007979
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007980 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7981 if (ret != 0) {
7982 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7983 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984
7985 /*
7986 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7987 * may define some other value. Currently (early 2016), no defined
7988 * ciphersuite does this (and this is unlikely to change as activity has
7989 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7990 */
7991 hash_len = 12;
7992
7993#if defined(MBEDTLS_SSL_RENEGOTIATION)
7994 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007996#endif
7997
7998 ssl->out_msglen = 4 + hash_len;
7999 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8000 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8001
8002 /*
8003 * In case of session resuming, invert the client and server
8004 * ChangeCipherSpec messages order.
8005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008007#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008011#endif
8012#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008014 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008020
8021 /*
8022 * Switch to our negotiated transform and session parameters for outbound
8023 * data.
8024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008026
8027#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029 unsigned char i;
8030
8031 /* Remember current epoch settings for resending */
8032 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8034 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008035
8036 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038
8039
8040 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 for (i = 2; i > 0; i--) {
8042 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008043 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 }
8045 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008046
8047 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (i == 0) {
8049 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8050 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008053#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008055
8056 ssl->transform_out = ssl->transform_negotiate;
8057 ssl->session_out = ssl->session_negotiate;
8058
8059#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8061 mbedtls_ssl_send_flight_completed(ssl);
8062 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008063#endif
8064
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8066 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8067 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008068 }
8069
8070#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8072 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8073 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8074 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008075 }
8076#endif
8077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008079
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008081}
8082
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008083#define SSL_MAX_HASH_LEN 12
8084
Gilles Peskine449bd832023-01-11 14:50:10 +01008085int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008086{
8087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8088 unsigned int hash_len = 12;
8089 unsigned char buf[SSL_MAX_HASH_LEN];
8090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008092
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008093 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8094 if (ret != 0) {
8095 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8096 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8099 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008100 goto exit;
8101 }
8102
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8104 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8105 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8106 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008107 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8108 goto exit;
8109 }
8110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8112 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8113 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008114 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8115 goto exit;
8116 }
8117
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8119 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8120 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8121 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008122 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8123 goto exit;
8124 }
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8127 buf, hash_len) != 0) {
8128 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8129 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8130 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008131 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8132 goto exit;
8133 }
8134
8135#if defined(MBEDTLS_SSL_RENEGOTIATION)
8136 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008138#endif
8139
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008141#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008143 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008145#endif
8146#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008148 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008150#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008152 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008154
8155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8157 mbedtls_ssl_recv_flight_completed(ssl);
8158 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008159#endif
8160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008162
8163exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 mbedtls_platform_zeroize(buf, hash_len);
8165 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008166}
8167
Jerry Yu392112c2022-02-17 14:34:10 +08008168#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8169/*
8170 * Helper to get TLS 1.2 PRF from ciphersuite
8171 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008173static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008174{
Jerry Yu392112c2022-02-17 14:34:10 +08008175 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008177#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8179 return tls_prf_sha384;
8180 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008181#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008182#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008183 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8185 return tls_prf_sha256;
8186 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008187 }
8188#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008189#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8190 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008191 (void) ciphersuite_info;
8192#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008193
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008195}
8196#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008197
Gilles Peskine449bd832023-01-11 14:50:10 +01008198static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008199{
8200 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008201#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 if (tls_prf == tls_prf_sha384) {
8203 return MBEDTLS_SSL_TLS_PRF_SHA384;
8204 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008205#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008206#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if (tls_prf == tls_prf_sha256) {
8208 return MBEDTLS_SSL_TLS_PRF_SHA256;
8209 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008210#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008212}
8213
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008214/*
8215 * Populate a transform structure with session keys and all the other
8216 * necessary information.
8217 *
8218 * Parameters:
8219 * - [in/out]: transform: structure to populate
8220 * [in] must be just initialised with mbedtls_ssl_transform_init()
8221 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8222 * - [in] ciphersuite
8223 * - [in] master
8224 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008225 * - [in] tls_prf: pointer to PRF to use for key derivation
8226 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008227 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008228 * - [in] endpoint: client or server
8229 * - [in] ssl: used for:
8230 * - ssl->conf->{f,p}_export_keys
8231 * [in] optionally used for:
8232 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8233 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008234MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008235static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8236 int ciphersuite,
8237 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008238#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008240#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 ssl_tls_prf_t tls_prf,
8242 const unsigned char randbytes[64],
8243 mbedtls_ssl_protocol_version tls_version,
8244 unsigned endpoint,
8245 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008246{
8247 int ret = 0;
8248 unsigned char keyblk[256];
8249 unsigned char *key1;
8250 unsigned char *key2;
8251 unsigned char *mac_enc;
8252 unsigned char *mac_dec;
8253 size_t mac_key_len = 0;
8254 size_t iv_copy_len;
8255 size_t keylen;
8256 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008257 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008258#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008259 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008260 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008261#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262
8263#if defined(MBEDTLS_USE_PSA_CRYPTO)
8264 psa_key_type_t key_type;
8265 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8266 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008267 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008268 size_t key_bits;
8269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8270#endif
8271
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008272 /*
8273 * Some data just needs copying into the structure
8274 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008275#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008276 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008278 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008279
8280#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008282#endif
8283
8284#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008286 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8287 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008289 }
8290#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8291
8292 /*
8293 * Get various info structures
8294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8296 if (ciphersuite_info == NULL) {
8297 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8298 ciphersuite));
8299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008300 }
8301
Neil Armstrongab555e02022-04-04 11:07:59 +02008302 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008303#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008305#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008307
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008309 transform->taglen =
8310 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008312
8313#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008314 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 transform->taglen,
8316 &alg,
8317 &key_type,
8318 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008319 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008321 goto end;
8322 }
8323#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008324 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if (cipher_info == NULL) {
8326 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8327 ciphersuite_info->cipher));
8328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008329 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008330#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008331
Neil Armstronge4512952022-03-08 09:08:22 +01008332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008333 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008335 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 (unsigned) ciphersuite_info->mac));
8337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008338 }
8339#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008340 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 if (md_info == NULL) {
8342 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8343 (unsigned) ciphersuite_info->mac));
8344 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345 }
Neil Armstronge4512952022-03-08 09:08:22 +01008346#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347
8348#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8349 /* Copy own and peer's CID if the use of the CID
8350 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8352 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008353
8354 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8356 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8357 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358
8359 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8361 ssl->handshake->peer_cid_len);
8362 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8363 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364 }
8365#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8366
8367 /*
8368 * Compute key block using the PRF
8369 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8371 if (ret != 0) {
8372 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8373 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374 }
8375
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8377 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8378 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8379 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8380 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008381
8382 /*
8383 * Determine the appropriate key, IV and MAC length.
8384 */
8385
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008386#if defined(MBEDTLS_USE_PSA_CRYPTO)
8387 keylen = PSA_BITS_TO_BYTES(key_bits);
8388#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008390#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008391
Valerio Settie5707042023-10-11 11:54:42 +02008392#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008394 size_t explicit_ivlen;
8395
8396 transform->maclen = 0;
8397 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398
8399 /* All modes haves 96-bit IVs, but the length of the static parts vary
8400 * with mode and version:
8401 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8402 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8403 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8404 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8405 * sequence number).
8406 */
8407 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008408
8409 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008410#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008412#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8414 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008415#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008416
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008418 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422
8423 /* Minimum length of encrypted record */
8424 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8425 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 } else
Valerio Settie5707042023-10-11 11:54:42 +02008427#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008428#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008430 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008432#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008434#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008435 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008436#endif /* MBEDTLS_USE_PSA_CRYPTO */
8437
8438#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008439 /* Get MAC length */
8440 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8441#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8444 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8445 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008446 goto end;
8447 }
8448
8449 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008451#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008452 transform->maclen = mac_key_len;
8453
8454 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008455#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008457#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008458 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008459#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008460
8461 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008463 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008465 /*
8466 * GenericBlockCipher:
8467 * 1. if EtM is in use: one block plus MAC
8468 * otherwise: * first multiple of blocklen greater than maclen
8469 * 2. IV
8470 */
8471#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008473 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 + block_size;
8475 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008476#endif
8477 {
8478 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 + block_size
8480 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 }
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008484 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 } else {
8486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008487 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8488 goto end;
8489 }
8490 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008492#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8493 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8495 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 }
8497
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8499 (unsigned) keylen,
8500 (unsigned) transform->minlen,
8501 (unsigned) transform->ivlen,
8502 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008503
8504 /*
8505 * Finally setup the cipher contexts, IVs and MAC secrets.
8506 */
8507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 key1 = keyblk + mac_key_len * 2;
8510 key2 = keyblk + mac_key_len * 2 + keylen;
8511
8512 mac_enc = keyblk;
8513 mac_dec = keyblk + mac_key_len;
8514
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 iv_copy_len = (transform->fixed_ivlen) ?
8516 transform->fixed_ivlen : transform->ivlen;
8517 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8518 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8519 iv_copy_len);
8520 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008521#endif /* MBEDTLS_SSL_CLI_C */
8522#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 key1 = keyblk + mac_key_len * 2 + keylen;
8525 key2 = keyblk + mac_key_len * 2;
8526
8527 mac_enc = keyblk + mac_key_len;
8528 mac_dec = keyblk;
8529
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 iv_copy_len = (transform->fixed_ivlen) ?
8531 transform->fixed_ivlen : transform->ivlen;
8532 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8533 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8534 iv_copy_len);
8535 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008536#endif /* MBEDTLS_SSL_SRV_C */
8537 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008539 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8540 goto end;
8541 }
8542
Paul Elliott4fb19552023-10-18 12:15:30 +01008543 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 ssl->f_export_keys(ssl->p_export_keys,
8545 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8546 master, 48,
8547 randbytes + 32,
8548 randbytes,
8549 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008550 }
8551
8552#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008553 transform->psa_alg = alg;
8554
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8556 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8557 psa_set_key_algorithm(&attributes, alg);
8558 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if ((status = psa_import_key(&attributes,
8561 key1,
8562 PSA_BITS_TO_BYTES(key_bits),
8563 &transform->psa_key_enc)) != PSA_SUCCESS) {
8564 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008565 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008567 goto end;
8568 }
8569
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008571
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 if ((status = psa_import_key(&attributes,
8573 key2,
8574 PSA_BITS_TO_BYTES(key_bits),
8575 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008576 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008578 goto end;
8579 }
8580 }
8581#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8583 cipher_info)) != 0) {
8584 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008585 goto end;
8586 }
8587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8589 cipher_info)) != 0) {
8590 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591 goto end;
8592 }
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8595 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8596 MBEDTLS_ENCRYPT)) != 0) {
8597 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008598 goto end;
8599 }
8600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8602 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8603 MBEDTLS_DECRYPT)) != 0) {
8604 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008605 goto end;
8606 }
8607
8608#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8610 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8611 MBEDTLS_PADDING_NONE)) != 0) {
8612 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008613 goto end;
8614 }
8615
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8617 MBEDTLS_PADDING_NONE)) != 0) {
8618 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008619 goto end;
8620 }
8621 }
8622#endif /* MBEDTLS_CIPHER_MODE_CBC */
8623#endif /* MBEDTLS_USE_PSA_CRYPTO */
8624
Neil Armstrong29c0c042022-03-17 17:47:28 +01008625#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8626 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8627 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008629#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8633 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8634 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008635
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 if ((status = psa_import_key(&attributes,
8637 mac_enc, mac_key_len,
8638 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008639 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008641 goto end;
8642 }
8643
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8645 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008646#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008648#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008650 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8652 PSA_KEY_USAGE_VERIFY_HASH);
8653 } else {
8654 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8655 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008656
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 if ((status = psa_import_key(&attributes,
8658 mac_dec, mac_key_len,
8659 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008660 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008662 goto end;
8663 }
8664#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8666 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008667 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 }
8669 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8670 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008671 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008673#endif /* MBEDTLS_USE_PSA_CRYPTO */
8674 }
8675#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8676
8677 ((void) mac_dec);
8678 ((void) mac_enc);
8679
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008680end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8682 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008683}
8684
Valerio Settia08b1a42022-11-17 15:10:02 +01008685#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8686 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008687int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 psa_pake_operation_t *pake_ctx,
8689 const unsigned char *buf,
8690 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008691{
8692 psa_status_t status;
8693 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008694 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008695 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8696 * At round two perform a single cycle
8697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 for (; remaining_steps > 0; remaining_steps--) {
8701 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008702 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008704 /* Length is stored at the first byte */
8705 size_t length = buf[input_offset];
8706 input_offset += 1;
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008709 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8710 }
8711
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 status = psa_pake_input(pake_ctx, step,
8713 buf + input_offset, length);
8714 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008715 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008716 }
8717
8718 input_offset += length;
8719 }
8720 }
8721
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008723 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008725
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008727}
8728
Valerio Setti6b3dab02022-11-17 17:14:54 +01008729int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 psa_pake_operation_t *pake_ctx,
8731 unsigned char *buf,
8732 size_t len, size_t *olen,
8733 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008734{
8735 psa_status_t status;
8736 size_t output_offset = 0;
8737 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008738 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008739 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8740 * At round two perform a single cycle
8741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008743
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 for (; remaining_steps > 0; remaining_steps--) {
8745 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8746 step <= PSA_PAKE_STEP_ZK_PROOF;
8747 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008748 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008749 * For each step, prepend 1 byte with the length of the data as
8750 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 status = psa_pake_output(pake_ctx, step,
8753 buf + output_offset + 1,
8754 len - output_offset - 1,
8755 &output_len);
8756 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008757 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008758 }
8759
Valerio Setti99d88c12022-11-22 16:03:43 +01008760 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008761
8762 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008763 }
8764 }
8765
8766 *olen = output_offset;
8767
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008769}
Valerio Settia08b1a42022-11-17 15:10:02 +01008770#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8771
Jerry Yuee40f9d2022-02-17 14:55:16 +08008772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008773int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8774 unsigned char *hash, size_t *hashlen,
8775 unsigned char *data, size_t data_len,
8776 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008777{
8778 psa_status_t status;
8779 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008780 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008783
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 if ((status = psa_hash_setup(&hash_operation,
8785 hash_alg)) != PSA_SUCCESS) {
8786 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008787 goto exit;
8788 }
8789
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8791 64)) != PSA_SUCCESS) {
8792 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008793 goto exit;
8794 }
8795
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 if ((status = psa_hash_update(&hash_operation,
8797 data, data_len)) != PSA_SUCCESS) {
8798 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799 goto exit;
8800 }
8801
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8803 hashlen)) != PSA_SUCCESS) {
8804 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8805 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008806 }
8807
8808exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 if (status != PSA_SUCCESS) {
8810 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8811 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8812 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008815 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8816 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008820 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008822 }
8823 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008825}
8826
8827#else
8828
Gilles Peskine449bd832023-01-11 14:50:10 +01008829int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8830 unsigned char *hash, size_t *hashlen,
8831 unsigned char *data, size_t data_len,
8832 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008833{
8834 int ret = 0;
8835 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8837 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008840
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008842
8843 /*
8844 * digitally-signed struct {
8845 * opaque client_random[32];
8846 * opaque server_random[32];
8847 * ServerDHParams params;
8848 * };
8849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8851 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008852 goto exit;
8853 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8855 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008856 goto exit;
8857 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8859 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008860 goto exit;
8861 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8863 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008864 goto exit;
8865 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008866 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8867 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008868 goto exit;
8869 }
8870
8871exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008873
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if (ret != 0) {
8875 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8876 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8877 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008878
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008880}
8881#endif /* MBEDTLS_USE_PSA_CRYPTO */
8882
Jerry Yud9d91da2022-02-17 14:57:06 +08008883#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8884
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008885/* Find the preferred hash for a given signature algorithm. */
8886unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 mbedtls_ssl_context *ssl,
8888 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008889{
Gabor Mezei078e8032022-04-27 21:17:56 +02008890 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008891 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008892
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8894 return MBEDTLS_SSL_HASH_NONE;
8895 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008896
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008898 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8900 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008901 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8903 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008904
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008905 mbedtls_md_type_t md_alg =
8906 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8907 if (md_alg == MBEDTLS_MD_NONE) {
8908 continue;
8909 }
8910
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008914 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008915 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8918 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8919 PSA_ALG_ECDSA(psa_hash_alg),
8920 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008921 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008923
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8925 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8926 PSA_ALG_RSA_PKCS1V15_SIGN(
8927 psa_hash_alg),
8928 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008929 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008931 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008932#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008933
Gilles Peskine449bd832023-01-11 14:50:10 +01008934 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008935 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008936 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008939}
8940
8941#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8942
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943/* Serialization of TLS 1.2 sessions:
8944 *
8945 * struct {
8946 * uint64 start_time;
8947 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008948 * uint8 session_id_len; // at most 32
8949 * opaque session_id[32];
8950 * opaque master[48]; // fixed length in the standard
8951 * uint32 verify_result;
8952 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8953 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8954 * uint32 ticket_lifetime;
8955 * uint8 mfl_code; // up to 255 according to standard
8956 * uint8 encrypt_then_mac; // 0 or 1
8957 * } serialized_session_tls12;
8958 *
8959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008960static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8961 unsigned char *buf,
8962 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008963{
8964 unsigned char *p = buf;
8965 size_t used = 0;
8966
8967#if defined(MBEDTLS_HAVE_TIME)
8968 uint64_t start;
8969#endif
8970#if defined(MBEDTLS_X509_CRT_PARSE_C)
8971#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8972 size_t cert_len;
8973#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8974#endif /* MBEDTLS_X509_CRT_PARSE_C */
8975
8976 /*
8977 * Time
8978 */
8979#if defined(MBEDTLS_HAVE_TIME)
8980 used += 8;
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008983 start = (uint64_t) session->start;
8984
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008986 p += 8;
8987 }
8988#endif /* MBEDTLS_HAVE_TIME */
8989
8990 /*
8991 * Basic mandatory fields
8992 */
8993 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 + 1 /* id_len */
8995 + sizeof(session->id)
8996 + sizeof(session->master)
8997 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 if (used <= buf_len) {
9000 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001 p += 2;
9002
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 *p++ = MBEDTLS_BYTE_0(session->id_len);
9004 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009005 p += 32;
9006
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009008 p += 48;
9009
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011 p += 4;
9012 }
9013
9014 /*
9015 * Peer's end-entity certificate
9016 */
9017#if defined(MBEDTLS_X509_CRT_PARSE_C)
9018#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009023 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009024
9025 used += 3 + cert_len;
9026
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 if (used <= buf_len) {
9028 *p++ = MBEDTLS_BYTE_2(cert_len);
9029 *p++ = MBEDTLS_BYTE_1(cert_len);
9030 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 if (session->peer_cert != NULL) {
9033 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009034 p += cert_len;
9035 }
9036 }
9037#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009039 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041 *p++ = (unsigned char) session->peer_cert_digest_type;
9042 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 memcpy(p, session->peer_cert_digest,
9044 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009045 p += session->peer_cert_digest_len;
9046 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009049 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009050 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9051 *p++ = 0;
9052 }
9053 }
9054#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9055#endif /* MBEDTLS_X509_CRT_PARSE_C */
9056
9057 /*
9058 * Session ticket if any, plus associated data
9059 */
9060#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9061 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 if (used <= buf_len) {
9064 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9065 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9066 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009067
Gilles Peskine449bd832023-01-11 14:50:10 +01009068 if (session->ticket != NULL) {
9069 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009070 p += session->ticket_len;
9071 }
9072
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074 p += 4;
9075 }
9076#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9077
9078 /*
9079 * Misc extension-related info
9080 */
9081#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9082 used += 1;
9083
Gilles Peskine449bd832023-01-11 14:50:10 +01009084 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009087#endif
9088
9089#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9090 used += 1;
9091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 if (used <= buf_len) {
9093 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9094 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095#endif
9096
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009098}
9099
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009100MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009101static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9102 const unsigned char *buf,
9103 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009104{
9105#if defined(MBEDTLS_HAVE_TIME)
9106 uint64_t start;
9107#endif
9108#if defined(MBEDTLS_X509_CRT_PARSE_C)
9109#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9110 size_t cert_len;
9111#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9112#endif /* MBEDTLS_X509_CRT_PARSE_C */
9113
9114 const unsigned char *p = buf;
9115 const unsigned char * const end = buf + len;
9116
9117 /*
9118 * Time
9119 */
9120#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 if (8 > (size_t) (end - p)) {
9122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9123 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009124
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009125 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009126 p += 8;
9127
9128 session->start = (time_t) start;
9129#endif /* MBEDTLS_HAVE_TIME */
9130
9131 /*
9132 * Basic mandatory fields
9133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9135 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9136 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009137
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009138 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139 p += 2;
9140
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009141 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009143 p += 32;
9144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146 p += 48;
9147
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009148 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009149 p += 4;
9150
9151 /* Immediately clear invalid pointer values that have been read, in case
9152 * we exit early before we replaced them with valid ones. */
9153#if defined(MBEDTLS_X509_CRT_PARSE_C)
9154#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9155 session->peer_cert = NULL;
9156#else
9157 session->peer_cert_digest = NULL;
9158#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9159#endif /* MBEDTLS_X509_CRT_PARSE_C */
9160#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9161 session->ticket = NULL;
9162#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9163
9164 /*
9165 * Peer certificate
9166 */
9167#if defined(MBEDTLS_X509_CRT_PARSE_C)
9168#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9169 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 if (3 > (size_t) (end - p)) {
9171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9172 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009173
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009174 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009175 p += 3;
9176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9179
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 if (cert_len > (size_t) (end - p)) {
9181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9182 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (session->peer_cert == NULL) {
9187 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9188 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9193 p, cert_len)) != 0) {
9194 mbedtls_x509_crt_free(session->peer_cert);
9195 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009198 }
9199
9200 p += cert_len;
9201 }
9202#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9203 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if (2 > (size_t) (end - p)) {
9205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9206 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009207
9208 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9209 session->peer_cert_digest_len = (size_t) *p++;
9210
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009212 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9214 if (md_info == NULL) {
9215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9216 }
9217 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9218 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9219 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009220
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9222 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9223 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224
9225 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 mbedtls_calloc(1, session->peer_cert_digest_len);
9227 if (session->peer_cert_digest == NULL) {
9228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9229 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009230
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 memcpy(session->peer_cert_digest, p,
9232 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009233 p += session->peer_cert_digest_len;
9234 }
9235#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9236#endif /* MBEDTLS_X509_CRT_PARSE_C */
9237
9238 /*
9239 * Session ticket and associated data
9240 */
9241#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if (3 > (size_t) (end - p)) {
9243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9244 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009245
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009246 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009247 p += 3;
9248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 if (session->ticket_len != 0) {
9250 if (session->ticket_len > (size_t) (end - p)) {
9251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9252 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009253
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 session->ticket = mbedtls_calloc(1, session->ticket_len);
9255 if (session->ticket == NULL) {
9256 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9257 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009260 p += session->ticket_len;
9261 }
9262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 if (4 > (size_t) (end - p)) {
9264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9265 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009266
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009267 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009268 p += 4;
9269#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9270
9271 /*
9272 * Misc extension-related info
9273 */
9274#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (1 > (size_t) (end - p)) {
9276 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9277 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009278
9279 session->mfl_code = *p++;
9280#endif
9281
9282#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (1 > (size_t) (end - p)) {
9284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9285 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009286
9287 session->encrypt_then_mac = *p++;
9288#endif
9289
9290 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009291 if (p != end) {
9292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9293 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009294
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009296}
Jerry Yudc7bd172022-02-17 13:44:15 +08009297#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9298
XiaokangQian75d40ef2022-04-20 11:05:24 +00009299int mbedtls_ssl_validate_ciphersuite(
9300 const mbedtls_ssl_context *ssl,
9301 const mbedtls_ssl_ciphersuite_t *suite_info,
9302 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009304{
9305 (void) ssl;
9306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 if (suite_info == NULL) {
9308 return -1;
9309 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 if ((suite_info->min_tls_version > max_tls_version) ||
9312 (suite_info->max_tls_version < min_tls_version)) {
9313 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009314 }
9315
XiaokangQian060d8672022-04-21 09:24:56 +00009316#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009317#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009318#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9320 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009321#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9323 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009324#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009325 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009326 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009327 }
9328#endif
9329
9330 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9331#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9333 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9334 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009335 }
9336#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9337#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009340}
9341
Ronald Crone68ab4f2022-10-05 12:46:29 +02009342#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009343/*
9344 * Function for writing a signature algorithm extension.
9345 *
9346 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9347 * value (TLS 1.3 RFC8446):
9348 * enum {
9349 * ....
9350 * ecdsa_secp256r1_sha256( 0x0403 ),
9351 * ecdsa_secp384r1_sha384( 0x0503 ),
9352 * ecdsa_secp521r1_sha512( 0x0603 ),
9353 * ....
9354 * } SignatureScheme;
9355 *
9356 * struct {
9357 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9358 * } SignatureSchemeList;
9359 *
9360 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9361 * value (TLS 1.2 RFC5246):
9362 * enum {
9363 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9364 * sha512(6), (255)
9365 * } HashAlgorithm;
9366 *
9367 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9368 * SignatureAlgorithm;
9369 *
9370 * struct {
9371 * HashAlgorithm hash;
9372 * SignatureAlgorithm signature;
9373 * } SignatureAndHashAlgorithm;
9374 *
9375 * SignatureAndHashAlgorithm
9376 * supported_signature_algorithms<2..2^16-2>;
9377 *
9378 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9379 * generalization of the TLS 1.2 signature algorithm extension.
9380 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9381 * `SignatureScheme` field of TLS 1.3
9382 *
9383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009384int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9385 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009386{
9387 unsigned char *p = buf;
9388 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9389 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9390
9391 *out_len = 0;
9392
Gilles Peskine449bd832023-01-11 14:50:10 +01009393 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009394
9395 /* Check if we have space for header and length field:
9396 * - extension_type (2 bytes)
9397 * - extension_data_length (2 bytes)
9398 * - supported_signature_algorithms_length (2 bytes)
9399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009401 p += 6;
9402
9403 /*
9404 * Write supported_signature_algorithms
9405 */
9406 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9408 if (sig_alg == NULL) {
9409 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9410 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009411
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9413 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9414 *sig_alg,
9415 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9416 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009417 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009418 }
9419 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9420 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009421 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9423 *sig_alg,
9424 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009425 }
9426
9427 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009428 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 if (supported_sig_alg_len == 0) {
9430 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9431 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009432 }
9433
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9435 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9436 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009437
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009438 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009439
9440#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009442#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009443
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009445}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009446#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009447
XiaokangQian40a35232022-05-07 09:02:40 +00009448#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009449/*
9450 * mbedtls_ssl_parse_server_name_ext
9451 *
9452 * Structure of server_name extension:
9453 *
9454 * enum {
9455 * host_name(0), (255)
9456 * } NameType;
9457 * opaque HostName<1..2^16-1>;
9458 *
9459 * struct {
9460 * NameType name_type;
9461 * select (name_type) {
9462 * case host_name: HostName;
9463 * } name;
9464 * } ServerName;
9465 * struct {
9466 * ServerName server_name_list<1..2^16-1>
9467 * } ServerNameList;
9468 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009470int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9471 const unsigned char *buf,
9472 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009473{
9474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9475 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009476 size_t server_name_list_len, hostname_len;
9477 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009480
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9482 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009483 p += 2;
9484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009486 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 while (p < server_name_list_end) {
9488 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9489 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9490 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9491 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009492
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009494 /* sni_name is intended to be used only during the parsing of the
9495 * ClientHello message (it is reset to NULL before the end of
9496 * the message parsing). Thus it is ok to just point to the
9497 * reception buffer and not make a copy of it.
9498 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009499 ssl->handshake->sni_name = p + 3;
9500 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 if (ssl->conf->f_sni == NULL) {
9502 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009503 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9505 ssl, p + 3, hostname_len);
9506 if (ret != 0) {
9507 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9508 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9509 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9510 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9511 }
9512 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009513 }
9514
9515 p += hostname_len + 3;
9516 }
9517
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009519}
9520#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9521
XiaokangQianacb39922022-06-17 10:18:48 +00009522#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009523MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009524int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9525 const unsigned char *buf,
9526 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009527{
9528 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009529 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009530 const unsigned char *protocol_name_list;
9531 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009532 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009533
9534 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 if (ssl->conf->alpn_list == NULL) {
9536 return 0;
9537 }
XiaokangQianacb39922022-06-17 10:18:48 +00009538
9539 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009540 * RFC7301, section 3.1
9541 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009542 *
XiaokangQianc7403452022-06-23 03:24:12 +00009543 * struct {
9544 * ProtocolName protocol_name_list<2..2^16-1>
9545 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009546 */
9547
XiaokangQianc7403452022-06-23 03:24:12 +00009548 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009549 * protocol_name_list_len 2 bytes
9550 * protocol_name_len 1 bytes
9551 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009554
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009556 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009557 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009558 protocol_name_list = p;
9559 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009560
9561 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009563 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9565 protocol_name_len);
9566 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009567 MBEDTLS_SSL_PEND_FATAL_ALERT(
9568 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9570 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 }
9572
9573 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009574 }
9575
9576 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9578 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009579 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009581 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009582 if (protocol_name_len == alpn_len &&
9583 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009584 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009586 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009587
9588 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009589 }
9590 }
9591
XiaokangQian95d5f542022-06-24 02:29:26 +00009592 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009593 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9595 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9596 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009597}
9598
Gilles Peskine449bd832023-01-11 14:50:10 +01009599int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9600 unsigned char *buf,
9601 unsigned char *end,
9602 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009603{
9604 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009605 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009606 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009607
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 if (ssl->alpn_chosen == NULL) {
9609 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009610 }
9611
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 protocol_name_len = strlen(ssl->alpn_chosen);
9613 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009616 /*
9617 * 0 . 1 ext identifier
9618 * 2 . 3 ext length
9619 * 4 . 5 protocol list length
9620 * 6 . 6 protocol name length
9621 * 7 . 7+n protocol name
9622 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009624
XiaokangQian95d5f542022-06-24 02:29:26 +00009625 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9628 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009629 /* Note: the length of the chosen protocol has been checked to be less
9630 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009633
Gilles Peskine449bd832023-01-11 14:50:10 +01009634 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009635
9636#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009638#endif
9639
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009641}
9642#endif /* MBEDTLS_SSL_ALPN */
9643
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009644#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009645 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009646 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009647 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009648int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9649 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650{
9651 /* Initialize to suppress unnecessary compiler warning */
9652 size_t hostname_len = 0;
9653
9654 /* Check if new hostname is valid before
9655 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009656 if (hostname != NULL) {
9657 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009658
Gilles Peskine449bd832023-01-11 14:50:10 +01009659 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9661 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662 }
9663
9664 /* Now it's clear that we will overwrite the old hostname,
9665 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009667 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009669 }
9670
9671 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009672 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009673 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 } else {
9675 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9676 if (session->hostname == NULL) {
9677 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9678 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009679
Gilles Peskine449bd832023-01-11 14:50:10 +01009680 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009681 }
9682
Gilles Peskine449bd832023-01-11 14:50:10 +01009683 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009684}
Xiaokang Qian03409292022-10-12 02:49:52 +00009685#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9686 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009687 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009688 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009690#endif /* MBEDTLS_SSL_TLS_C */