blob: f229360411c6ff044892a39934cfe932493f3992 [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
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#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
Chien Wong4e9683e2023-12-28 17:07:43 +0800634static const 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
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_EARLY_DATA)
1102#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron90e22332024-01-22 15:24:21 +01001103 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_UNKNOWN;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001104#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001105#if defined(MBEDTLS_SSL_SRV_C)
1106 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1107#endif
1108#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001109
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001110 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 mbedtls_ssl_session_init(ssl->session_negotiate);
1112 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001113
Jerry Yu2e199812022-12-01 18:57:19 +08001114#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001116#endif
1117
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001118 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001119 ret = mbedtls_ssl_reset_checksum(ssl);
1120 if (ret != 0) {
1121 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1122 return ret;
1123 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001124
Jerry Yud0766ec2022-09-22 10:46:57 +08001125#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1126 defined(MBEDTLS_SSL_SRV_C) && \
1127 defined(MBEDTLS_SSL_SESSION_TICKETS)
1128 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001130#endif
1131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001137 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001143 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001144#endif
1145
Brett Warrene0edc842021-08-17 09:53:13 +01001146/*
1147 * curve_list is translated to IANA TLS group identifiers here because
1148 * mbedtls_ssl_conf_curves returns void and so can't return
1149 * any error codes.
1150 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001151#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001152#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1153 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001155 size_t length;
1156 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1157
Thomas Daubney850a0792023-05-22 12:05:03 +01001158 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 }
Brett Warrene0edc842021-08-17 09:53:13 +01001160
1161 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1163 if (group_list == NULL) {
1164 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1165 }
Brett Warrene0edc842021-08-17 09:53:13 +01001166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001168 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 curve_list[i]);
1170 if (tls_id == 0) {
1171 mbedtls_free(group_list);
1172 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001173 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001174 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001175 }
1176
1177 group_list[length] = 0;
1178
1179 ssl->handshake->group_list = group_list;
1180 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001182 ssl->handshake->group_list = ssl->conf->group_list;
1183 ssl->handshake->group_list_heap_allocated = 0;
1184 }
1185#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001186#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001187
Ronald Crone68ab4f2022-10-05 12:46:29 +02001188#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001189#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001190#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001191 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1192 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1194 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 const int *md;
1196 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001197 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001198 uint16_t *p;
1199
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001200 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1201 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1202 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001203
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1205 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001206 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001208#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001210#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001211
Jerry Yub476a442022-01-21 18:14:45 +08001212#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001214#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1216 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1217 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 }
1219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1221 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1222 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001223
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1225 sizeof(uint16_t));
1226 if (ssl->handshake->sig_algs == NULL) {
1227 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1228 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 p = (uint16_t *) ssl->handshake->sig_algs;
1231 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1232 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1233 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001236#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001238 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001239#endif
1240#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001242 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001243#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001245 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001248#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001249 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 ssl->handshake->sig_algs_heap_allocated = 0;
1251 }
Jerry Yucc539102022-06-27 16:27:35 +08001252#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001253#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001255}
1256
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001257#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001258/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001259MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001260static int ssl_cookie_write_dummy(void *ctx,
1261 unsigned char **p, unsigned char *end,
1262 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001263{
1264 ((void) ctx);
1265 ((void) p);
1266 ((void) end);
1267 ((void) cli_id);
1268 ((void) cli_id_len);
1269
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001271}
1272
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001274static int ssl_cookie_check_dummy(void *ctx,
1275 const unsigned char *cookie, size_t cookie_len,
1276 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277{
1278 ((void) ctx);
1279 ((void) cookie);
1280 ((void) cookie_len);
1281 ((void) cli_id);
1282 ((void) cli_id_len);
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001285}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001286#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287
Paul Bakker5121ce52009-01-03 21:22:43 +00001288/*
1289 * Initialize an SSL context
1290 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001291void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001292{
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001294}
1295
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001296MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001297static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001298{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001299 const mbedtls_ssl_config *conf = ssl->conf;
1300
Ronald Cron6f135e12021-12-08 16:57:54 +01001301#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1303 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1304 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1305 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001306 }
1307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1309 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001310 }
1311#endif
1312
1313#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1315 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1316 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001317 }
1318#endif
1319
Ronald Cron6f135e12021-12-08 16:57:54 +01001320#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1322 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1323 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001325 }
1326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1333 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001334}
1335
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001336MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001337static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1338{
1339 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 ret = ssl_conf_version_check(ssl);
1341 if (ret != 0) {
1342 return ret;
1343 }
Jerry Yu60835a82021-08-04 10:13:52 +08001344
Jerry Yudef7ae42022-10-30 14:13:19 +08001345#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1346 /* RFC 8446 section 4.4.3
1347 *
1348 * If the verification fails, the receiver MUST terminate the handshake with
1349 * a "decrypt_error" alert.
1350 *
1351 * If the client is configured as TLS 1.3 only with optional verify, return
1352 * bad config.
1353 *
1354 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001355 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001357 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1358 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1359 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001361 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 1, ("Optional verify auth mode "
1363 "is not available for TLS 1.3 client"));
1364 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001365 }
1366#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1367
Jerry Yu60835a82021-08-04 10:13:52 +08001368 /* Space for further checks */
1369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001371}
1372
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001373/*
1374 * Setup an SSL context
1375 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1378 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001379{
Janos Follath865b3eb2019-12-16 11:46:15 +00001380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001381 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1382 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001383
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001384 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if ((ret = ssl_conf_check(ssl)) != 0) {
1387 return ret;
1388 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001389 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001390
Paul Bakker62f2dee2012-09-28 07:31:51 +00001391 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001392 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001394
1395 /* Set to NULL in case of an error condition */
1396 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->in_buf_len = in_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1402 if (ssl->in_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001406 }
1407
Darryl Greenb33cc762019-11-28 14:29:44 +00001408#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1409 ssl->out_buf_len = out_buf_len;
1410#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1412 if (ssl->out_buf == NULL) {
1413 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001414 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001416 }
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001419
Johan Pascalb62bb512015-12-03 21:56:45 +01001420#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#endif
1423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001425 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001429
1430error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 mbedtls_free(ssl->in_buf);
1432 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001433
1434 ssl->conf = NULL;
1435
Darryl Greenb33cc762019-11-28 14:29:44 +00001436#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1437 ssl->in_buf_len = 0;
1438 ssl->out_buf_len = 0;
1439#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001440 ssl->in_buf = NULL;
1441 ssl->out_buf = NULL;
1442
1443 ssl->in_hdr = NULL;
1444 ssl->in_ctr = NULL;
1445 ssl->in_len = NULL;
1446 ssl->in_iv = NULL;
1447 ssl->in_msg = NULL;
1448
1449 ssl->out_hdr = NULL;
1450 ssl->out_ctr = NULL;
1451 ssl->out_len = NULL;
1452 ssl->out_iv = NULL;
1453 ssl->out_msg = NULL;
1454
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001456}
1457
1458/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459 * Reset an initialized and used SSL context for re-use while retaining
1460 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001461 *
1462 * If partial is non-zero, keep data in the input buffer and client ID.
1463 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1466 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001467{
Darryl Greenb33cc762019-11-28 14:29:44 +00001468#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1469 size_t in_buf_len = ssl->in_buf_len;
1470 size_t out_buf_len = ssl->out_buf_len;
1471#else
1472 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1473 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1474#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001475
Hanno Beckerb0302c42021-08-03 09:39:42 +01001476#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1477 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001478#endif
1479
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001480 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001484
1485 /* Reset incoming message parsing */
1486 ssl->in_offt = NULL;
1487 ssl->nb_zero = 0;
1488 ssl->in_msgtype = 0;
1489 ssl->in_msglen = 0;
1490 ssl->in_hslen = 0;
1491 ssl->keep_current_message = 0;
1492 ssl->transform_in = NULL;
1493
1494#if defined(MBEDTLS_SSL_PROTO_DTLS)
1495 ssl->next_record_offset = 0;
1496 ssl->in_epoch = 0;
1497#endif
1498
1499 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 }
1504
Ronald Cronad8c17b2022-06-10 17:18:09 +02001505 ssl->send_alert = 0;
1506
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 /* Reset outgoing message writing */
1508 ssl->out_msgtype = 0;
1509 ssl->out_msglen = 0;
1510 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 memset(ssl->out_buf, 0, out_buf_len);
1512 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform_out = NULL;
1514
1515#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517#endif
1518
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 if (ssl->transform) {
1521 mbedtls_ssl_transform_free(ssl->transform);
1522 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523 ssl->transform = NULL;
1524 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1526
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 mbedtls_ssl_transform_free(ssl->transform_application);
1529 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 ssl->transform_application = NULL;
1531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001533#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1535 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001537#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1540 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001541 ssl->handshake->transform_handshake = NULL;
1542 }
1543
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001545}
1546
Gilles Peskine449bd832023-01-11 14:50:10 +01001547int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001548{
1549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1550
1551 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001554
1555 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#if defined(MBEDTLS_SSL_RENEGOTIATION)
1557 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001559
1560 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1562 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001563#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001565
Hanno Beckerb0302c42021-08-03 09:39:42 +01001566 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001567 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 if (ssl->session) {
1569 mbedtls_ssl_session_free(ssl->session);
1570 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001571 ssl->session = NULL;
1572 }
1573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001575 ssl->alpn_chosen = NULL;
1576#endif
1577
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001578#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001579 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001580#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (free_cli_id) {
1584 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001585 ssl->cli_id = NULL;
1586 ssl->cli_id_len = 0;
1587 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001588#endif
1589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 if ((ret = ssl_handshake_init(ssl)) != 0) {
1591 return ret;
1592 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001595}
1596
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001597/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001598 * Reset an initialized and used SSL context for re-use while retaining
1599 * all application-set variables, function pointers and data.
1600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001601int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001602{
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604}
1605
1606/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001607 * SSL set accessors
1608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001612}
1613
Gilles Peskine449bd832023-01-11 14:50:10 +01001614void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001615{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001616 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617}
1618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623}
1624#endif
1625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001627{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001628 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1634 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001635{
1636 ssl->disable_datagram_packing = !allow_packing;
1637}
1638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1640 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001641{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001642 conf->hs_timeout_min = min;
1643 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001644}
1645#endif
1646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001648{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001649 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001650}
1651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001653void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1654 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1655 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001657 conf->f_vrfy = f_vrfy;
1658 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001659}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661
Gilles Peskine449bd832023-01-11 14:50:10 +01001662void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1663 int (*f_rng)(void *, unsigned char *, size_t),
1664 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001665{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001666 conf->f_rng = f_rng;
1667 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1671 void (*f_dbg)(void *, int, const char *, int, const char *),
1672 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001673{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001674 conf->f_dbg = f_dbg;
1675 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001676}
1677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1679 void *p_bio,
1680 mbedtls_ssl_send_t *f_send,
1681 mbedtls_ssl_recv_t *f_recv,
1682 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001683{
1684 ssl->p_bio = p_bio;
1685 ssl->f_send = f_send;
1686 ssl->f_recv = f_recv;
1687 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688}
1689
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001691void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692{
1693 ssl->mtu = mtu;
1694}
1695#endif
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001698{
1699 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001700}
1701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1703 void *p_timer,
1704 mbedtls_ssl_set_timer_t *f_set_timer,
1705 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001706{
1707 ssl->p_timer = p_timer;
1708 ssl->f_set_timer = f_set_timer;
1709 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001710
1711 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001713}
1714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001716void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1717 void *p_cache,
1718 mbedtls_ssl_cache_get_t *f_get_cache,
1719 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001720{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001721 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001722 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001723 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001724}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001728int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001729{
Janos Follath865b3eb2019-12-16 11:46:15 +00001730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733 session == NULL ||
1734 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001737 }
1738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (ssl->handshake->resume == 1) {
1740 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1741 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001742
Jerry Yu21092062022-10-10 21:21:31 +08001743#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001745 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001749 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1751 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1752 session->ciphersuite));
1753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001754 }
Jerry Yu40afab62022-10-08 10:42:13 +08001755 }
Jerry Yu21092062022-10-10 21:21:31 +08001756#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1759 session)) != 0) {
1760 return ret;
1761 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001762
Paul Bakker0a597072012-09-25 21:55:46 +00001763 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001766}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1770 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001771{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001772 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001773}
1774
Ronald Cron6f135e12021-12-08 16:57:54 +01001775#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001776void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1777 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001778{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001779 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001781
1782#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001783void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1784 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001785{
1786 conf->early_data_enabled = early_data_enabled;
1787}
Jerry Yucc4e0072022-11-22 17:22:22 +08001788
1789#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001790void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001792{
Jerry Yu39da9852022-12-06 16:58:36 +08001793 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001794}
1795#endif /* MBEDTLS_SSL_SRV_C */
1796
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001797#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001798#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001801void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1802 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001803{
1804 conf->cert_profile = profile;
1805}
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001808{
1809 mbedtls_ssl_key_cert *cur = key_cert, *next;
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001812 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 cur = next;
1815 }
1816}
1817
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001818/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001819MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001820static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1821 mbedtls_x509_crt *cert,
1822 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001823{
niisato8ee24222018-06-25 19:05:48 +09001824 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001827 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 }
1832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1834 if (new_cert == NULL) {
1835 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1836 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001837
niisato8ee24222018-06-25 19:05:48 +09001838 new_cert->cert = cert;
1839 new_cert->key = key;
1840 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
Glenn Strauss36872db2022-01-22 05:06:31 -05001842 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001844 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001846 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 }
niisato8ee24222018-06-25 19:05:48 +09001850 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851 }
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001854}
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859{
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001861}
1862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001864 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001866{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001867 conf->ca_chain = ca_chain;
1868 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001869
1870#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1871 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1872 * cannot be used together. */
1873 conf->f_ca_cb = NULL;
1874 conf->p_ca_cb = NULL;
1875#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001876}
Hanno Becker5adaad92019-03-27 16:54:37 +00001877
1878#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001879void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1880 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1881 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001882{
1883 conf->f_ca_cb = f_ca_cb;
1884 conf->p_ca_cb = p_ca_cb;
1885
1886 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1887 * cannot be used together. */
1888 conf->ca_chain = NULL;
1889 conf->ca_crl = NULL;
1890}
1891#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001893
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001894#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001895const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1896 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001897{
1898 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001900}
1901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1903 mbedtls_x509_crt *own_cert,
1904 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001905{
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1907 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001908}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1911 mbedtls_x509_crt *ca_chain,
1912 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001913{
1914 ssl->handshake->sni_ca_chain = ca_chain;
1915 ssl->handshake->sni_ca_crl = ca_crl;
1916}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001917
Glenn Strauss999ef702022-03-11 01:37:23 -05001918#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001919void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1920 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001921{
1922 ssl->handshake->dn_hints = crt;
1923}
1924#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1927 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001928{
1929 ssl->handshake->sni_authmode = authmode;
1930}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001931#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1932
Hanno Becker8927c832019-04-03 12:52:50 +01001933#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001934void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1935 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1936 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001937{
1938 ssl->f_vrfy = f_vrfy;
1939 ssl->p_vrfy = p_vrfy;
1940}
1941#endif
1942
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001943#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001944
Valerio Setti016f6822022-12-09 14:17:50 +01001945#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001946static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1947static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1948
Valerio Setti016f6822022-12-09 14:17:50 +01001949static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 mbedtls_ssl_context *ssl,
1951 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001952{
1953 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001954 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001955 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001956 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1960 psa_pake_cs_set_primitive(&cipher_suite,
1961 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1962 PSA_ECC_FAMILY_SECP_R1,
1963 256));
1964 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1967 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001968 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001972 user = jpake_server_id;
1973 user_len = sizeof(jpake_server_id);
1974 peer = jpake_client_id;
1975 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001977 user = jpake_client_id;
1978 user_len = sizeof(jpake_client_id);
1979 peer = jpake_server_id;
1980 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001982
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1984 if (status != PSA_SUCCESS) {
1985 return status;
1986 }
1987
1988 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001990 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Valerio Setti016f6822022-12-09 14:17:50 +01001997
1998 ssl->handshake->psa_pake_ctx_is_ok = 1;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002001}
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2004 const unsigned char *pw,
2005 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002006{
2007 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2008 psa_status_t status;
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (ssl->handshake == NULL || ssl->conf == NULL) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002012 }
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 /* Empty password is not valid */
2015 if ((pw == NULL) || (pw_len == 0)) {
2016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2017 }
2018
2019 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2020 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2021 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2022
2023 status = psa_import_key(&attributes, pw, pw_len,
2024 &ssl->handshake->psa_pake_password);
2025 if (status != PSA_SUCCESS) {
2026 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2027 }
2028
2029 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2030 ssl->handshake->psa_pake_password);
2031 if (status != PSA_SUCCESS) {
2032 psa_destroy_key(ssl->handshake->psa_pake_password);
2033 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2034 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2035 }
2036
2037 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002038}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2041 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043 psa_status_t status;
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (ssl->handshake == NULL || ssl->conf == NULL) {
2046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002047 }
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (mbedtls_svc_key_id_is_null(pwd)) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2051 }
2052
2053 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2054 if (status != PSA_SUCCESS) {
2055 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2056 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2057 }
2058
2059 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002060}
2061#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002062int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2063 const unsigned char *pw,
2064 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002065{
2066 mbedtls_ecjpake_role role;
2067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (ssl->handshake == NULL || ssl->conf == NULL) {
2069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2070 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002071
Valerio Settic689ed82022-12-07 14:40:38 +01002072 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if ((pw == NULL) || (pw_len == 0)) {
2074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2075 }
Valerio Settic689ed82022-12-07 14:40:38 +01002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2084 role,
2085 MBEDTLS_MD_SHA256,
2086 MBEDTLS_ECP_DP_SECP256R1,
2087 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002088}
Valerio Setti02c25b52022-11-15 14:08:42 +01002089#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002090#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091
Ronald Cron73fe8df2022-10-05 14:31:43 +02002092#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002093int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094{
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (conf->psk_identity == NULL ||
2096 conf->psk_identity_len == 0) {
2097 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002098 }
2099
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2102 return 1;
2103 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (conf->psk != NULL && conf->psk_len != 0) {
2107 return 1;
2108 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111}
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114{
2115 /* Remove reference to existing PSK, if any. */
2116#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118 /* The maintenance of the PSK key slot is the
2119 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002120 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002124 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125 conf->psk = NULL;
2126 conf->psk_len = 0;
2127 }
2128
2129 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 if (conf->psk_identity != NULL) {
2131 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002132 conf->psk_identity = NULL;
2133 conf->psk_identity_len = 0;
2134 }
2135}
2136
Hanno Becker7390c712018-11-15 13:33:04 +00002137/* This function assumes that PSK identity in the SSL config is unset.
2138 * It checks that the provided identity is well-formed and attempts
2139 * to make a copy of it in the SSL config.
2140 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002142static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2143 unsigned char const *psk_identity,
2144 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002145{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002146 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002148 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 (psk_identity_len >> 16) != 0 ||
2150 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002152 }
2153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2155 if (conf->psk_identity == NULL) {
2156 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2157 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002158
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002159 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002163}
2164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2166 const unsigned char *psk, size_t psk_len,
2167 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002168{
Janos Follath865b3eb2019-12-16 11:46:15 +00002169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002170
2171 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2173 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2174 }
Hanno Becker7390c712018-11-15 13:33:04 +00002175
2176 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (psk == NULL) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2179 }
2180 if (psk_len == 0) {
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2182 }
2183 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2185 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002186
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2188 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2189 }
Hanno Becker7390c712018-11-15 13:33:04 +00002190 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002192
2193 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2195 if (ret != 0) {
2196 ssl_conf_remove_psk(conf);
2197 }
Hanno Becker7390c712018-11-15 13:33:04 +00002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002200}
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203{
2204#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002206 /* The maintenance of the external PSK key slot is the
2207 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (ssl->handshake->psk_opaque_is_internal) {
2209 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002210 ssl->handshake->psk_opaque_is_internal = 0;
2211 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002212 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002213 }
Neil Armstronge952a302022-05-03 10:22:14 +02002214#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002216 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002218 ssl->handshake->psk_len = 0;
2219 }
Neil Armstronge952a302022-05-03 10:22:14 +02002220#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002221}
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2224 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002225{
Neil Armstrong501c9322022-05-03 09:35:09 +02002226#if defined(MBEDTLS_USE_PSA_CRYPTO)
2227 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002229 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002231#endif /* MBEDTLS_USE_PSA_CRYPTO */
2232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (psk == NULL || ssl->handshake == NULL) {
2234 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2235 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2239 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Neil Armstrong501c9322022-05-03 09:35:09 +02002243#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002244#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2246 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2247 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2248 } else {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2250 }
2251 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002252 }
2253#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002254
Jerry Yu568ec252022-07-22 21:27:34 +08002255#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2257 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2258 psa_set_key_usage_flags(&key_attributes,
2259 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002260 }
2261#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 psa_set_key_algorithm(&key_attributes, alg);
2264 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2267 if (status != PSA_SUCCESS) {
2268 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2269 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002270
2271 /* Allow calling psa_destroy_key() on psk remove */
2272 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002274#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2276 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2277 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002278
2279 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002283#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002284}
2285
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002286#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002287int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2288 mbedtls_svc_key_id_t psk,
2289 const unsigned char *psk_identity,
2290 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291{
Janos Follath865b3eb2019-12-16 11:46:15 +00002292 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002293
2294 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2297 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002298
Hanno Becker7390c712018-11-15 13:33:04 +00002299 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (mbedtls_svc_key_id_is_null(psk)) {
2301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2302 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002303 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002304
2305 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2307 psk_identity_len);
2308 if (ret != 0) {
2309 ssl_conf_remove_psk(conf);
2310 }
Hanno Becker7390c712018-11-15 13:33:04 +00002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002313}
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2316 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002317{
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 if ((mbedtls_svc_key_id_is_null(psk)) ||
2319 (ssl->handshake == NULL)) {
2320 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2321 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326}
2327#endif /* MBEDTLS_USE_PSA_CRYPTO */
2328
Jerry Yu8897c072022-08-12 13:56:53 +08002329#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002330void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2331 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2332 size_t),
2333 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002334{
2335 conf->f_psk = f_psk;
2336 conf->p_psk = p_psk;
2337}
Jerry Yu8897c072022-08-12 13:56:53 +08002338#endif /* MBEDTLS_SSL_SRV_C */
2339
Ronald Cron73fe8df2022-10-05 14:31:43 +02002340#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002341
2342#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002343static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002345{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002346#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (alg == PSA_ALG_CBC_NO_PADDING) {
2348 return MBEDTLS_SSL_MODE_CBC;
2349 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (PSA_ALG_IS_AEAD(alg)) {
2352 return MBEDTLS_SSL_MODE_AEAD;
2353 }
2354 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002355}
2356
2357#else /* MBEDTLS_USE_PSA_CRYPTO */
2358
2359static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002361{
2362#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 if (mode == MBEDTLS_MODE_CBC) {
2364 return MBEDTLS_SSL_MODE_CBC;
2365 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002366#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2367
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368#if defined(MBEDTLS_GCM_C) || \
2369 defined(MBEDTLS_CCM_C) || \
2370 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 mode == MBEDTLS_MODE_CHACHAPOLY) {
2374 return MBEDTLS_SSL_MODE_AEAD;
2375 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002376#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379}
Gilles Peskine301711e2022-04-26 16:57:05 +02002380#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381
Gilles Peskinee108d982022-04-26 16:50:40 +02002382static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2383 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002385{
2386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2388 base_mode == MBEDTLS_SSL_MODE_CBC) {
2389 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 }
2391#else
2392 (void) encrypt_then_mac;
2393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002395}
2396
Neil Armstrongab555e02022-04-04 11:07:59 +02002397mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002399{
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002405#endif
2406 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002407
Gilles Peskinee108d982022-04-26 16:50:40 +02002408 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002409#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 encrypt_then_mac = transform->encrypt_then_mac;
2411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413}
2414
Neil Armstrongab555e02022-04-04 11:07:59 +02002415mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002416#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002420{
Gilles Peskinee108d982022-04-26 16:50:40 +02002421 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2422
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#if defined(MBEDTLS_USE_PSA_CRYPTO)
2424 psa_status_t status;
2425 psa_algorithm_t alg;
2426 psa_key_type_t type;
2427 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002428 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2429 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (status == PSA_SUCCESS) {
2431 base_mode = mbedtls_ssl_get_base_mode(alg);
2432 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002433#else
2434 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002435 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002437 base_mode =
2438 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002440 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441#endif /* MBEDTLS_USE_PSA_CRYPTO */
2442
Gilles Peskinee108d982022-04-26 16:50:40 +02002443#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2444 int encrypt_then_mac = 0;
2445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002447}
2448
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002449#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002450
2451#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002452/* Serialization of TLS 1.3 sessions:
2453 *
2454 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002455 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002456 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002457 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002458 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002459 * } ClientOnlyData;
2460 *
2461 * struct {
Jerry Yu438ddd82022-07-07 06:55:50 +00002462 * uint32 ticket_age_add;
2463 * uint8 ticket_flags;
2464 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002465 * uint32 max_early_data_size;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002466 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002467 * select ( endpoint ) {
2468 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002469 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002470 * };
2471 * } serialized_session_tls13;
2472 *
2473 */
2474#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002475MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002476static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2477 unsigned char *buf,
2478 size_t buf_len,
2479 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002480{
2481 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002482#if defined(MBEDTLS_SSL_CLI_C) && \
2483 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 size_t hostname_len = (session->hostname == NULL) ?
2485 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002486#endif
Ronald Cron40a4ab02024-01-15 10:21:30 +01002487 size_t needed = 4 /* ticket_age_add */
2488 + 1 /* ticket_flags */
2489 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002490 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2493 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2494 }
Jerry Yu34191072022-08-18 10:32:09 +08002495 needed += session->resumption_key_len; /* resumption_key */
2496
Jerry Yu02e3a072022-12-12 15:13:20 +08002497#if defined(MBEDTLS_SSL_EARLY_DATA)
2498 needed += 4; /* max_early_data_size */
2499#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002500#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002501 needed += 2; /* record_size_limit */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002502#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002503
Jerry Yu438ddd82022-07-07 06:55:50 +00002504#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002505 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002506#endif
2507
2508#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002510#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002511 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002513#endif
2514
Jerry Yu438ddd82022-07-07 06:55:50 +00002515 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002516 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002517
2518 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 if (session->ticket_len > SIZE_MAX - needed) {
2520 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2521 }
Jerry Yu34191072022-08-18 10:32:09 +08002522
Jerry Yue28d9742022-08-18 15:44:03 +08002523 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002524 }
2525#endif /* MBEDTLS_SSL_CLI_C */
2526
Jerry Yue36fdd62022-08-17 21:31:36 +08002527 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (needed > buf_len) {
2529 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2530 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002531
Ronald Cron40a4ab02024-01-15 10:21:30 +01002532 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
2533 p[4] = session->ticket_flags;
Jerry Yu438ddd82022-07-07 06:55:50 +00002534
2535 /* save resumption_key */
Ronald Cron40a4ab02024-01-15 10:21:30 +01002536 p[5] = session->resumption_key_len;
2537 p += 6;
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002539 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002540
Jerry Yu02e3a072022-12-12 15:13:20 +08002541#if defined(MBEDTLS_SSL_EARLY_DATA)
2542 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2543 p += 4;
2544#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002545#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2546 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2547 p += 2;
2548#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002549
Jerry Yu438ddd82022-07-07 06:55:50 +00002550#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002552 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002553 p += 8;
2554 }
2555#endif /* MBEDTLS_HAVE_TIME */
2556
2557#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002563 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002565 p += hostname_len;
2566 }
2567#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2568
Jerry Yu438ddd82022-07-07 06:55:50 +00002569#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002570 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += 8;
2572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += 4;
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (session->ticket != NULL && session->ticket_len > 0) {
2580 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002581 p += session->ticket_len;
2582 }
2583 }
2584#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002586}
2587
2588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2590 const unsigned char *buf,
2591 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002592{
2593 const unsigned char *p = buf;
2594 const unsigned char *end = buf + len;
2595
Ronald Cron40a4ab02024-01-15 10:21:30 +01002596 if (end - p < 6) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Ronald Cron40a4ab02024-01-15 10:21:30 +01002599 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
2600 session->ticket_flags = p[4];
Jerry Yu438ddd82022-07-07 06:55:50 +00002601
2602 /* load resumption_key */
Ronald Cron40a4ab02024-01-15 10:21:30 +01002603 session->resumption_key_len = p[5];
2604 p += 6;
Jerry Yu438ddd82022-07-07 06:55:50 +00002605
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
David Horstmann5c5a32f2024-02-13 17:53:35 +00003665#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3666#define SSL_SERIALIZED_SESSION_KEEP_PEER_CRT 1
3667#else
3668#define SSL_SERIALIZED_SESSION_KEEP_PEER_CRT 0
3669#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3670
Hanno Becker94ef3b32019-05-16 12:50:45 +01003671#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003672#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003673#else
Hanno Becker3e088662019-05-29 11:10:18 +01003674#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003675#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3676
3677#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003678#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003679#else
Hanno Becker3e088662019-05-29 11:10:18 +01003680#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003681#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3682
Hanno Becker94ef3b32019-05-16 12:50:45 +01003683#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003684#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003685#else
Hanno Becker3e088662019-05-29 11:10:18 +01003686#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003687#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3688
Hanno Becker94ef3b32019-05-16 12:50:45 +01003689#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3690#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3691#else
3692#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3693#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3694
Hanno Becker3e088662019-05-29 11:10:18 +01003695#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3696#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3697#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3698#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003699#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3700#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmann5c5a32f2024-02-13 17:53:35 +00003701#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_CRT_BIT 6
Hanno Becker3e088662019-05-29 11:10:18 +01003702
Hanno Becker50b59662019-05-28 14:30:45 +01003703#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003704 ((uint16_t) ( \
3705 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3706 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3707 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3708 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3709 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3710 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003711 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
3712 (SSL_SERIALIZED_SESSION_KEEP_PEER_CRT << SSL_SERIALIZED_SESSION_CONFIG_KEEP_CRT_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003713
Chien Wong4e9683e2023-12-28 17:07:43 +08003714static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003715 MBEDTLS_VERSION_MAJOR,
3716 MBEDTLS_VERSION_MINOR,
3717 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003718 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3719 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003720};
Hanno Beckera835da52019-05-16 12:39:07 +01003721
3722/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003723 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003724 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003725 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003727 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003728 * opaque mbedtls_version[3]; // library version: major, minor, patch
3729 * opaque session_format[2]; // library-version specific 16-bit field
3730 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003731 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003732 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003733 * Note: When updating the format, remember to keep
3734 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003735 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003736 * // In this version, `session_format` determines
3737 * // the setting of those compile-time
3738 * // configuration options which influence
3739 * // the structure of mbedtls_ssl_session.
3740 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003741 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003742 * // - TLS 1.2 (0x0303)
3743 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003745 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003746 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003747 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003748 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003749 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003750 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003751 *
3752 * };
3753 *
3754 * } serialized_session;
3755 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003756 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003757
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003759static int ssl_session_save(const mbedtls_ssl_session *session,
3760 unsigned char omit_header,
3761 unsigned char *buf,
3762 size_t buf_len,
3763 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003764{
3765 unsigned char *p = buf;
3766 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003767 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003768#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3769 size_t out_len;
3770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3771#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 if (session == NULL) {
3773 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3774 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003775
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003777 /*
3778 * Add Mbed TLS version identifier
3779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 if (used <= buf_len) {
3783 memcpy(p, ssl_serialized_session_header,
3784 sizeof(ssl_serialized_session_header));
3785 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003786 }
3787 }
3788
3789 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003790 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003791 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003792 used += 1 /* TLS version */
3793 + 1 /* endpoint */
3794 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01003795 if (used <= buf_len) {
3796 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003797 *p++ = session->endpoint;
3798 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
3799 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003800 }
3801
3802 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003803 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003804 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003805#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 case MBEDTLS_SSL_VERSION_TLS1_2:
3807 used += ssl_tls12_session_save(session, p, remaining_len);
3808 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003809#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3810
Jerry Yu251a12e2022-07-13 15:15:48 +08003811#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 case MBEDTLS_SSL_VERSION_TLS1_3:
3813 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3814 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3815 return ret;
3816 }
3817 used += out_len;
3818 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003819#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3820
Gilles Peskine449bd832023-01-11 14:50:10 +01003821 default:
3822 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003823 }
3824
3825 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 if (used > buf_len) {
3827 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3828 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003829
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003831}
3832
3833/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003834 * Public wrapper for ssl_session_save()
3835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003836int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3837 unsigned char *buf,
3838 size_t buf_len,
3839 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003840{
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003842}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003843
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003844/*
3845 * Deserialize session, see mbedtls_ssl_session_save() for format.
3846 *
3847 * This internal version is wrapped by a public function that cleans up in
3848 * case of error, and has an extra option omit_header.
3849 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003850MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003851static int ssl_session_load(mbedtls_ssl_session *session,
3852 unsigned char omit_header,
3853 const unsigned char *buf,
3854 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003855{
3856 const unsigned char *p = buf;
3857 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003858 size_t remaining_len;
3859
3860
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 if (session == NULL) {
3862 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3863 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003864
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003866 /*
3867 * Check Mbed TLS version identifier
3868 */
3869
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3871 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003872 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003873
3874 if (memcmp(p, ssl_serialized_session_header,
3875 sizeof(ssl_serialized_session_header)) != 0) {
3876 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3877 }
3878 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003879 }
3880
3881 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003882 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003883 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003884 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3886 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003887 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003888 session->endpoint = *p++;
3889 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
3890 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003891
3892 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003893 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003895#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003896 case MBEDTLS_SSL_VERSION_TLS1_2:
3897 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003898#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3899
Jerry Yu438ddd82022-07-07 06:55:50 +00003900#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 case MBEDTLS_SSL_VERSION_TLS1_3:
3902 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003903#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3904
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 default:
3906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003907 }
3908}
3909
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003910/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003911 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003913int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3914 const unsigned char *buf,
3915 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003916{
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003918
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 if (ret != 0) {
3920 mbedtls_ssl_session_free(session);
3921 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003922
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003924}
3925
3926/*
Paul Bakker1961b702013-01-25 14:49:24 +01003927 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003928 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003929MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003930static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003931{
3932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3933
Ronald Cron66dbf912022-02-02 15:33:46 +01003934 /*
3935 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003936 * that were written into the output buffer by the previous handshake step,
3937 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003938 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3939 * We proceed to the next handshake step only when all data from the
3940 * previous one have been sent to the peer, thus we make sure that this is
3941 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3942 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3943 * we have to wait before to go ahead.
3944 * In the case of TLS 1.3, handshake step handlers do not send data to the
3945 * peer. Data are only sent here and through
3946 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003947 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3950 return ret;
3951 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003952
3953#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3955 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3956 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3957 return ret;
3958 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003959 }
3960#endif /* MBEDTLS_SSL_PROTO_DTLS */
3961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003963}
3964
Gilles Peskine449bd832023-01-11 14:50:10 +01003965int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003966{
Hanno Becker41934dd2021-08-07 19:13:43 +01003967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003970 ssl->conf == NULL ||
3971 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003974 }
3975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 ret = ssl_prepare_handshake_step(ssl);
3977 if (ret != 0) {
3978 return ret;
3979 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003980
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 ret = mbedtls_ssl_handle_pending_alert(ssl);
3982 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003983 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 }
Jerry Yue7047812021-09-13 19:26:39 +08003985
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003986 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3987 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3988 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003990#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3992 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003993 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003994
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003996 case MBEDTLS_SSL_HELLO_REQUEST:
3997 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003998 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003999 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004000
Ronald Cron9f0fba32022-02-10 16:45:15 +01004001 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004003 break;
4004
4005 default:
4006#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4008 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4009 } else {
4010 ret = mbedtls_ssl_handshake_client_step(ssl);
4011 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004012#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004014#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004016#endif
4017 }
Jerry Yub9930e72021-08-06 17:11:51 +08004018 }
Ronald Cron6291b232023-03-08 15:51:25 +01004019#endif /* MBEDTLS_SSL_CLI_C */
4020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004023#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4024 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004026 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 ret = mbedtls_ssl_handshake_server_step(ssl);
4028 }
Ronald Cron6291b232023-03-08 15:51:25 +01004029#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4030 ret = mbedtls_ssl_handshake_server_step(ssl);
4031#else
4032 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004033#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004034 }
4035#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004038 /* handshake_step return error. And it is same
4039 * with alert_reason.
4040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 if (ssl->send_alert) {
4042 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004043 goto cleanup;
4044 }
4045 }
4046
4047cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004049}
4050
4051/*
4052 * Perform the SSL handshake
4053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004054int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004055{
4056 int ret = 0;
4057
Hanno Beckera817ea42020-10-20 15:20:23 +01004058 /* Sanity checks */
4059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (ssl == NULL || ssl->conf == NULL) {
4061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4062 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004063
Hanno Beckera817ea42020-10-20 15:20:23 +01004064#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4066 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4067 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4068 "mbedtls_ssl_set_timer_cb() for DTLS"));
4069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004070 }
4071#endif /* MBEDTLS_SSL_PROTO_DTLS */
4072
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004074
Hanno Beckera817ea42020-10-20 15:20:23 +01004075 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4077 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004080 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 }
Paul Bakker1961b702013-01-25 14:49:24 +01004082 }
4083
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004087}
4088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004089#if defined(MBEDTLS_SSL_RENEGOTIATION)
4090#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004091/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004092 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004093 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004094MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004095static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004096{
Janos Follath865b3eb2019-12-16 11:46:15 +00004097 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004100
4101 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004102 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4103 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004104
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4106 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4107 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004108 }
4109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004113}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004114#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004115
4116/*
4117 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004118 * - any side: calling mbedtls_ssl_renegotiate(),
4119 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4120 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004121 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004122 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004123 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004125int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004126{
Janos Follath865b3eb2019-12-16 11:46:15 +00004127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 if ((ret = ssl_handshake_init(ssl)) != 0) {
4132 return ret;
4133 }
Paul Bakker48916f92012-09-16 19:57:18 +00004134
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004135 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4136 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004137#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4139 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4140 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004141 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004143 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004145 }
4146#endif
4147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004148 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4149 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4152 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4153 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004154 }
4155
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004157
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004159}
4160
4161/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004162 * Renegotiate current connection on client,
4163 * or request renegotiation on server
4164 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004166{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004167 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004168
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 if (ssl == NULL || ssl->conf == NULL) {
4170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4171 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004174 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4176 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4178 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004180 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004181
4182 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (ssl->out_left != 0) {
4184 return mbedtls_ssl_flush_output(ssl);
4185 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004188 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004189#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004191#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004192 /*
4193 * On client, either start the renegotiation process or,
4194 * if already in progress, continue the handshake
4195 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4197 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4198 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004199 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004200
4201 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4202 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4203 return ret;
4204 }
4205 } else {
4206 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4207 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4208 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004209 }
4210 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004211#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004212
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004214}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004215#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004218{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004219 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004222 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004224
Valerio Setti6f0441d2023-07-03 12:11:36 +02004225#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004226#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if (ssl->handshake->group_list_heap_allocated) {
4228 mbedtls_free((void *) handshake->group_list);
4229 }
Brett Warrene0edc842021-08-17 09:53:13 +01004230 handshake->group_list = NULL;
4231#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004232#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004233
Ronald Crone68ab4f2022-10-05 12:46:29 +02004234#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004235#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (ssl->handshake->sig_algs_heap_allocated) {
4237 mbedtls_free((void *) handshake->sig_algs);
4238 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004239 handshake->sig_algs = NULL;
4240#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004241#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (ssl->handshake->certificate_request_context) {
4243 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004244 }
4245#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004246#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004247
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004248#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4250 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004251 handshake->async_in_progress = 0;
4252 }
4253#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4254
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004255#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004256#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004258#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004259 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004260#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004261#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004262#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004263#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004265#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004266 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004267#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004268#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004270#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004272#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004273#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004274 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004276#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004277
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004278#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004279#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004281 /*
4282 * Opaque keys are not stored in the handshake's data and it's the user
4283 * responsibility to destroy them. Clear ones, instead, are created by
4284 * the TLS library and should be destroyed at the same level
4285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4287 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004288 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004289 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4290#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004292#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004293#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004295 handshake->ecjpake_cache = NULL;
4296 handshake->ecjpake_cache_len = 0;
4297#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004298#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004299
Valerio Setti7aeec542023-07-05 18:57:21 +02004300#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004301 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004302 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004303 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004305#endif
4306
Ronald Cron73fe8df2022-10-05 14:31:43 +02004307#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004308#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004310 /* The maintenance of the external PSK key slot is the
4311 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (ssl->handshake->psk_opaque_is_internal) {
4313 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004314 ssl->handshake->psk_opaque_is_internal = 0;
4315 }
4316 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4317 }
Neil Armstronge952a302022-05-03 10:22:14 +02004318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004320 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004321 }
Neil Armstronge952a302022-05-03 10:22:14 +02004322#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004323#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004325#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4326 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004327 /*
4328 * Free only the linked list wrapper, not the keys themselves
4329 * since the belong to the SNI callback
4330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004332#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004333
Gilles Peskineeccd8882020-03-10 12:19:08 +01004334#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4336 if (handshake->ecrs_peer_cert != NULL) {
4337 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4338 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004339 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004340#endif
4341
Hanno Becker75173122019-02-06 16:18:31 +00004342#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4343 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004345#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4346
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004347#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4349 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004350#endif /* MBEDTLS_SSL_CLI_C &&
4351 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004352
4353#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 mbedtls_ssl_flight_free(handshake->flight);
4355 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004356#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004357
Valerio Settiea59c432023-07-25 11:14:03 +02004358#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004359 if (handshake->xxdh_psa_privkey_is_external == 0) {
4360 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 }
Valerio Settiea59c432023-07-25 11:14:03 +02004362#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004363
Ronald Cron6f135e12021-12-08 16:57:54 +01004364#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 mbedtls_ssl_transform_free(handshake->transform_handshake);
4366 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004367#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4369 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004370#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004371#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004372
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004373
4374#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4375 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4376 * processes datagrams and the fact that a datagram is allowed to have
4377 * several records in it, it is possible that the I/O buffers are not
4378 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4380 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004381#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004382
Jerry Yuba9c7272021-10-30 11:54:10 +08004383 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 mbedtls_platform_zeroize(handshake,
4385 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004386}
4387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004389{
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004391 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004396#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004397
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004398#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004399#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4400 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004404#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004407}
4408
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004409#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004410
4411#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4412#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4413#else
4414#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4415#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4416
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004417#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004418
4419#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4420#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4421#else
4422#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4423#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4424
4425#if defined(MBEDTLS_SSL_ALPN)
4426#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4427#else
4428#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4429#endif /* MBEDTLS_SSL_ALPN */
4430
4431#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4432#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4433#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4434#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4435
4436#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 ((uint32_t) ( \
4438 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4439 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4440 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4441 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4442 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4443 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4444 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4445 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004446
Chien Wong4e9683e2023-12-28 17:07:43 +08004447static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004448 MBEDTLS_VERSION_MAJOR,
4449 MBEDTLS_VERSION_MINOR,
4450 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4452 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4453 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4454 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4455 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004456};
4457
Paul Bakker5121ce52009-01-03 21:22:43 +00004458/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004459 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004460 *
4461 * The format of the serialized data is:
4462 * (in the presentation language of TLS, RFC 8446 section 3)
4463 *
4464 * // header
4465 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004466 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004467 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004468 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004469 * Note: When updating the format, remember to keep these
4470 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004471 *
4472 * // session sub-structure
4473 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4474 * // transform sub-structure
4475 * uint8 random[64]; // ServerHello.random+ClientHello.random
4476 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4477 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4478 * // fields from ssl_context
4479 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4480 * uint64 in_window_top; // DTLS: last validated record seq_num
4481 * uint64 in_window; // DTLS: bitmask for replay protection
4482 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4483 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4484 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4485 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4486 *
4487 * Note that many fields of the ssl_context or sub-structures are not
4488 * serialized, as they fall in one of the following categories:
4489 *
4490 * 1. forced value (eg in_left must be 0)
4491 * 2. pointer to dynamically-allocated memory (eg session, transform)
4492 * 3. value can be re-derived from other data (eg session keys from MS)
4493 * 4. value was temporary (eg content of input buffer)
4494 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4497 unsigned char *buf,
4498 size_t buf_len,
4499 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004500{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004501 unsigned char *p = buf;
4502 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004503 size_t session_len;
4504 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004505
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004506 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004507 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4508 * this function's documentation.
4509 *
4510 * These are due to assumptions/limitations in the implementation. Some of
4511 * them are likely to stay (no handshake in progress) some might go away
4512 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004513 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004514 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4516 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4517 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004518 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 if (ssl->handshake != NULL) {
4520 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4521 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004522 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004523 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (ssl->transform == NULL || ssl->session == NULL) {
4525 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4526 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004527 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004528 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (mbedtls_ssl_check_pending(ssl) != 0) {
4530 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4531 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004532 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (ssl->out_left != 0) {
4534 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4535 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004536 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004537 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4539 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
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 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4544 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4545 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004546 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004547 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4549 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4550 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004551 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004552 /* Renegotiation must not be enabled */
4553#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4555 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4556 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004557 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004558#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004559
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004560 /*
4561 * Version and format identifier
4562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (used <= buf_len) {
4566 memcpy(p, ssl_serialized_context_header,
4567 sizeof(ssl_serialized_context_header));
4568 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004569 }
4570
4571 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004572 * Session (length + data)
4573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4575 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4576 return ret;
4577 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004578
4579 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (used <= buf_len) {
4581 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004582 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 ret = ssl_session_save(ssl->session, 1,
4585 p, session_len, &session_len);
4586 if (ret != 0) {
4587 return ret;
4588 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004589
4590 p += session_len;
4591 }
4592
4593 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004594 * Transform
4595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 used += sizeof(ssl->transform->randbytes);
4597 if (used <= buf_len) {
4598 memcpy(p, ssl->transform->randbytes,
4599 sizeof(ssl->transform->randbytes));
4600 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004601 }
4602
4603#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004604 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004606 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004608 p += ssl->transform->in_cid_len;
4609
4610 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004612 p += ssl->transform->out_cid_len;
4613 }
4614#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4615
4616 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004617 * Saved fields from top-level ssl_context structure
4618 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004619 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (used <= buf_len) {
4621 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004622 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004623 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004624
4625#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4626 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (used <= buf_len) {
4628 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004629 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004632 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004633 }
4634#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4635
4636#if defined(MBEDTLS_SSL_PROTO_DTLS)
4637 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004639 *p++ = ssl->disable_datagram_packing;
4640 }
4641#endif /* MBEDTLS_SSL_PROTO_DTLS */
4642
Jerry Yuae0b2e22021-10-08 15:21:19 +08004643 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (used <= buf_len) {
4645 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004646 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004647 }
4648
4649#if defined(MBEDTLS_SSL_PROTO_DTLS)
4650 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if (used <= buf_len) {
4652 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004653 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004654 }
4655#endif /* MBEDTLS_SSL_PROTO_DTLS */
4656
4657#if defined(MBEDTLS_SSL_ALPN)
4658 {
4659 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004661 : 0;
4662
4663 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004665 *p++ = alpn_len;
4666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 if (ssl->alpn_chosen != NULL) {
4668 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004669 p += alpn_len;
4670 }
4671 }
4672 }
4673#endif /* MBEDTLS_SSL_ALPN */
4674
4675 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004676 * Done
4677 */
4678 *olen = used;
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (used > buf_len) {
4681 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4682 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004683
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004687}
4688
4689/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004690 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004691 *
4692 * This internal version is wrapped by a public function that cleans up in
4693 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004694 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004695MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004696static int ssl_context_load(mbedtls_ssl_context *ssl,
4697 const unsigned char *buf,
4698 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004699{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004700 const unsigned char *p = buf;
4701 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004702 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004705 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004706#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004707
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004708 /*
4709 * The context should have been freshly setup or reset.
4710 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004711 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004712 * renegotiating, or if the user mistakenly loaded a session first.)
4713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4715 ssl->session != NULL) {
4716 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004717 }
4718
4719 /*
4720 * We can't check that the config matches the initial one, but we can at
4721 * least check it matches the requirements for serializing.
4722 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004723 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004724#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004725 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004726#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004727 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4728 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4729 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4730 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004732 }
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004735
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004736 /*
4737 * Check version identifier
4738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004742
4743 if (memcmp(p, ssl_serialized_context_header,
4744 sizeof(ssl_serialized_context_header)) != 0) {
4745 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4746 }
4747 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004748
4749 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004750 * Session
4751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if ((size_t) (end - p) < 4) {
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4754 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004755
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004756 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004757 p += 4;
4758
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004759 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004760 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004761 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004762 ssl->session_in = ssl->session;
4763 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004764 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if ((size_t) (end - p) < session_len) {
4767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4768 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 ret = ssl_session_load(ssl->session, 1, p, session_len);
4771 if (ret != 0) {
4772 mbedtls_ssl_session_free(ssl->session);
4773 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004774 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004775
4776 p += session_len;
4777
4778 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004779 * Transform
4780 */
4781
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004782 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004783 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004784#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004785 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004786 ssl->transform_in = ssl->transform;
4787 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004788 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004789#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004790
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004791#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4793 if (prf_func == NULL) {
4794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4795 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004796
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004797 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4799 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4800 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 ret = ssl_tls12_populate_transform(ssl->transform,
4803 ssl->session->ciphersuite,
4804 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004805#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004807#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 prf_func,
4809 p, /* currently pointing to randbytes */
4810 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4811 ssl->conf->endpoint,
4812 ssl);
4813 if (ret != 0) {
4814 return ret;
4815 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004818
4819#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4820 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 if ((size_t) (end - p) < 1) {
4822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4823 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004824
4825 ssl->transform->in_cid_len = *p++;
4826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4829 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004832 p += ssl->transform->in_cid_len;
4833
4834 ssl->transform->out_cid_len = *p++;
4835
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4838 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004841 p += ssl->transform->out_cid_len;
4842#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4843
4844 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 * Saved fields from top-level ssl_context structure
4846 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if ((size_t) (end - p) < 4) {
4848 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4849 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004850
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004851 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004852 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004853
4854#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 if ((size_t) (end - p) < 16) {
4856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4857 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004858
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004859 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004860 p += 8;
4861
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004862 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004863 p += 8;
4864#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4865
4866#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if ((size_t) (end - p) < 1) {
4868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4869 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004870
4871 ssl->disable_datagram_packing = *p++;
4872#endif /* MBEDTLS_SSL_PROTO_DTLS */
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4876 }
4877 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4878 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879
4880#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if ((size_t) (end - p) < 2) {
4882 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4883 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004884
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004885 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004886 p += 2;
4887#endif /* MBEDTLS_SSL_PROTO_DTLS */
4888
4889#if defined(MBEDTLS_SSL_ALPN)
4890 {
4891 uint8_t alpn_len;
4892 const char **cur;
4893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if ((size_t) (end - p) < 1) {
4895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4896 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004897
4898 alpn_len = *p++;
4899
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004901 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4903 if (strlen(*cur) == alpn_len &&
4904 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004905 ssl->alpn_chosen = *cur;
4906 break;
4907 }
4908 }
4909 }
4910
4911 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4914 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004915
4916 p += alpn_len;
4917 }
4918#endif /* MBEDTLS_SSL_ALPN */
4919
4920 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004921 * Forced fields from top-level ssl_context structure
4922 *
4923 * Most of them already set to the correct value by mbedtls_ssl_init() and
4924 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4925 */
4926 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004927 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004928
Hanno Becker361b10d2019-08-30 10:42:49 +01004929 /* Adjust pointers for header fields of outgoing records to
4930 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004932
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004933#if defined(MBEDTLS_SSL_PROTO_DTLS)
4934 ssl->in_epoch = 1;
4935#endif
4936
4937 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4938 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004939 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4940 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (ssl->handshake != NULL) {
4942 mbedtls_ssl_handshake_free(ssl);
4943 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004944 ssl->handshake = NULL;
4945 }
4946
4947 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004948 * Done - should have consumed entire buffer
4949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 if (p != end) {
4951 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4952 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004955}
4956
4957/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004958 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4961 const unsigned char *buf,
4962 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004963{
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (ret != 0) {
4967 mbedtls_ssl_free(context);
4968 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004971}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004972#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004973
4974/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004975 * Free an SSL context
4976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004977void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004978{
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004980 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004986#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4987 size_t out_buf_len = ssl->out_buf_len;
4988#else
4989 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4990#endif
4991
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004992 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004993 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004994 }
4995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4998 size_t in_buf_len = ssl->in_buf_len;
4999#else
5000 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5001#endif
5002
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005003 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005004 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005005 }
5006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 if (ssl->transform) {
5008 mbedtls_ssl_transform_free(ssl->transform);
5009 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005010 }
5011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 if (ssl->handshake) {
5013 mbedtls_ssl_handshake_free(ssl);
5014 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005015
5016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5018 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005019#endif
5020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 mbedtls_ssl_session_free(ssl->session_negotiate);
5022 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005023 }
5024
Ronald Cron6f135e12021-12-08 16:57:54 +01005025#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 mbedtls_ssl_transform_free(ssl->transform_application);
5027 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005028#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (ssl->session) {
5031 mbedtls_ssl_session_free(ssl->session);
5032 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005033 }
5034
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005037 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005038 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005039#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005040
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005041#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005043#endif
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005046
Paul Bakker86f04f42013-02-14 11:20:09 +01005047 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005049}
5050
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005051/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005052 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005055{
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005057}
5058
Gilles Peskineae270bf2021-06-02 00:05:29 +02005059/* The selection should be the same as mbedtls_x509_crt_profile_default in
5060 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005061 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005062 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005063 * about this list.
5064 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005065static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005066#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005067 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005068#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005069#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005070 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005071#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005072#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005073 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005074#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005075#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005076 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005077#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005078#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005079 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005080#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005081#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005082 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005083#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005084#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005085 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005086#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005087#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005088 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005089#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005090#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005091 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5092 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5093 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5094 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5095 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5096#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005097 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005098};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005099
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005100static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005101 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5102 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5103 0
5104};
5105
Ronald Crone68ab4f2022-10-05 12:46:29 +02005106#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005107
Jerry Yu909df7b2022-01-22 11:56:27 +08005108/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005109 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005110 * rules SHOULD be upheld.
5111 * - No duplicate entries.
5112 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005113 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005114 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005115 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005116static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005117
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005119 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005120 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005121 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005122 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5123#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005124
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005125#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005126 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005127 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005128 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005129 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5130#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005131
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005132#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005133 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005134 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005135 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005136 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5137#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005138
Yanray Wang1136fad2023-11-22 16:54:31 +08005139#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005140 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005141#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005142
Yanray Wang1136fad2023-11-22 16:54:31 +08005143#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005144 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005145#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005146
Yanray Wang1136fad2023-11-22 16:54:31 +08005147#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005148 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005149#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005150
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005151#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005152 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005153#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005154
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005155#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005156 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005157#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005158
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005159#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005160 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005161#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005162
Gabor Mezei15b95a62022-05-09 16:37:58 +02005163 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005164};
5165
5166/* NOTICE: see above */
5167#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5168static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005169
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005170#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005171#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005173#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005174#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5175 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005176#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005177#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005179#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005180#endif /* MBEDTLS_MD_CAN_SHA512 */
5181
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005182#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005183#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005185#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005186#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5187 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005188#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005189#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005191#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005192#endif /* MBEDTLS_MD_CAN_SHA384 */
5193
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005194#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005195#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005197#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005198#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5199 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005200#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005201#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005203#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005204#endif /* MBEDTLS_MD_CAN_SHA256 */
5205
Gabor Mezei15b95a62022-05-09 16:37:58 +02005206 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005207};
5208#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005209
Jerry Yu909df7b2022-01-22 11:56:27 +08005210/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005211static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005212
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005213#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005214 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005215 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005216 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005217 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5218#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005219
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005220#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005221 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005222 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005223 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005224 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5225#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005226
Gabor Mezei15b95a62022-05-09 16:37:58 +02005227 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005228};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005229
Jerry Yu909df7b2022-01-22 11:56:27 +08005230/* NOTICE: see above */
5231#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5232static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005233
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005234#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005235#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005237#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005238#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005239
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005240#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005241#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005243#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005244#endif /* MBEDTLS_MD_CAN_SHA384 */
5245
Gabor Mezei15b95a62022-05-09 16:37:58 +02005246 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005247};
Jerry Yu909df7b2022-01-22 11:56:27 +08005248#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5249
Ronald Crone68ab4f2022-10-05 12:46:29 +02005250#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005251
Chien Wong4e9683e2023-12-28 17:07:43 +08005252static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005253#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005254 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005255#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005256#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005257 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005258#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005259 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005260};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005261
Ronald Crone68ab4f2022-10-05 12:46:29 +02005262#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005263/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005264 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005265MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005266static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005267{
5268 size_t i, j;
5269 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005270
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5272 for (j = 0; j < i; j++) {
5273 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005274 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 }
5276 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5277 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5278 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005279 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005280 }
5281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005283}
5284
Ronald Crone68ab4f2022-10-05 12:46:29 +02005285#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005286
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005287/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005288 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005290int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5291 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005292{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005293#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005295#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005296
Ronald Crone68ab4f2022-10-05 12:46:29 +02005297#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5299 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5300 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005301 }
5302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5304 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5305 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005306 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005307
5308#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5310 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5311 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005312 }
5313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5315 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5316 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005317 }
5318#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005319#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005320
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005321 /* Use the functions here so that they are covered in tests,
5322 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 mbedtls_ssl_conf_endpoint(conf, endpoint);
5324 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005325
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005326 /*
5327 * Things that are common to all presets
5328 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005329#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005331 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5332#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5333 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5334#endif
5335 }
5336#endif
5337
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005338#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5339 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5340#endif
5341
5342#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5343 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5344#endif
5345
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005346#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005347 conf->f_cookie_write = ssl_cookie_write_dummy;
5348 conf->f_cookie_check = ssl_cookie_check_dummy;
5349#endif
5350
5351#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5352 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5353#endif
5354
Janos Follath088ce432017-04-10 12:42:31 +01005355#if defined(MBEDTLS_SSL_SRV_C)
5356 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005357 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005358#endif
5359
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005360#if defined(MBEDTLS_SSL_PROTO_DTLS)
5361 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5362 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5363#endif
5364
5365#if defined(MBEDTLS_SSL_RENEGOTIATION)
5366 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 memset(conf->renego_period, 0x00, 2);
5368 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005369#endif
5370
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005371#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005373 const unsigned char dhm_p[] =
5374 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5375 const unsigned char dhm_g[] =
5376 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005377
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5379 dhm_p, sizeof(dhm_p),
5380 dhm_g, sizeof(dhm_g))) != 0) {
5381 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005382 }
5383 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005384#endif
5385
Ronald Cron6f135e12021-12-08 16:57:54 +01005386#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005387
5388#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005389 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005390#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005391 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005392#endif
5393#endif /* MBEDTLS_SSL_EARLY_DATA */
5394
Jerry Yud0766ec2022-09-22 10:46:57 +08005395#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005396 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005398#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005399 /*
5400 * Allow all TLS 1.3 key exchange modes by default.
5401 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005402 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005403#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005404
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005406#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005407 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005408 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005409#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005413#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005414 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5415 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005416#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5417 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5418 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5419#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5420 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5421 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5422#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005424#endif
5425 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005426
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005427 /*
5428 * Preset-specific defaults
5429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005431 /*
5432 * NSA Suite B
5433 */
5434 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005435
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005436 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005437
5438#if defined(MBEDTLS_X509_CRT_PARSE_C)
5439 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005440#endif
5441
Ronald Crone68ab4f2022-10-05 12:46:29 +02005442#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005445 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005447#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005449#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005450
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005451#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005452 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005453#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005454 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005455 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005456
5457 /*
5458 * Default
5459 */
5460 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005461
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005462 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005463
5464#if defined(MBEDTLS_X509_CRT_PARSE_C)
5465 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5466#endif
5467
Ronald Crone68ab4f2022-10-05 12:46:29 +02005468#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005469#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005471 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005473#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005475#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005476
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005477#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005478 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005479#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005480 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005481
5482#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5483 conf->dhm_min_bitlen = 1024;
5484#endif
5485 }
5486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005488}
5489
5490/*
5491 * Free mbedtls_ssl_config
5492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005493void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005494{
5495#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 mbedtls_mpi_free(&conf->dhm_P);
5497 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005498#endif
5499
Ronald Cron73fe8df2022-10-05 14:31:43 +02005500#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005501#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005503 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5504 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005505#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005507 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005508 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005509 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005510 }
5511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005513 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005514 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005515 conf->psk_identity_len = 0;
5516 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005517#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005518
5519#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005521#endif
5522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005524}
5525
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005526#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005527 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005528/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005531unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005532{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5535 return MBEDTLS_SSL_SIG_RSA;
5536 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005537#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005538#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5540 return MBEDTLS_SSL_SIG_ECDSA;
5541 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005542#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005544}
5545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005547{
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005549 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005551 case MBEDTLS_PK_ECDSA:
5552 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005554 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005556 }
5557}
5558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005560{
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005562#if defined(MBEDTLS_RSA_C)
5563 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005565#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005566#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005567 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005569#endif
5570 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005572 }
5573}
Valerio Settie9646ec2023-08-02 20:02:28 +02005574#endif /* MBEDTLS_PK_C &&
5575 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005576
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005577/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005578 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005580mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005581{
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005583#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005586#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005587#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005590#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005591#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005592 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005594#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005595#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005596 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005598#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005599#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005600 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005602#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005603#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005604 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005606#endif
5607 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005609 }
5610}
5611
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005612/*
5613 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005615unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005616{
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005618#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005619 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005621#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005622#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005623 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005625#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005626#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005627 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005629#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005630#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005631 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005633#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005634#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005635 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005637#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005638#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005639 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005641#endif
5642 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005644 }
5645}
5646
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005647/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005648 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005649 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005650 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005651int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005652{
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005654
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (group_list == NULL) {
5656 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005657 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 for (; *group_list != 0; group_list++) {
5660 if (*group_list == tls_id) {
5661 return 0;
5662 }
5663 }
5664
5665 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005666}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005667
Valerio Setti49e69072023-06-27 17:27:51 +02005668#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005669/*
5670 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005673{
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005677 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005679
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005681}
Valerio Setti49e69072023-06-27 17:27:51 +02005682#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005683
Valerio Setti18c9fed2022-12-30 17:44:24 +01005684static const struct {
5685 uint16_t tls_id;
5686 mbedtls_ecp_group_id ecp_group_id;
5687 psa_ecc_family_t psa_family;
5688 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005689} tls_id_match_table[] =
5690{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005691#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005692 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005693#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005694#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005695 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005696#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005697#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005698 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005699#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005700#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005701 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005702#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005703#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005704 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005705#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005706#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005707 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005708#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005709#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005710 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005711#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005712#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005713 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005714#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005715#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005716 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005717#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005718#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005719 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005720#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005721#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005722 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005723#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005724#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005725 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005726#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005727#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005728 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005729#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005730 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005731};
5732
Gilles Peskine449bd832023-01-11 14:50:10 +01005733int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005734 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005736{
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5738 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005739 if (type != NULL) {
5740 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
5742 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005743 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005745 return PSA_SUCCESS;
5746 }
5747 }
5748
5749 return PSA_ERROR_NOT_SUPPORTED;
5750}
5751
Gilles Peskine449bd832023-01-11 14:50:10 +01005752mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005753{
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5755 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005756 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005758 }
5759
5760 return MBEDTLS_ECP_DP_NONE;
5761}
5762
Gilles Peskine449bd832023-01-11 14:50:10 +01005763uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005764{
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5766 i++) {
5767 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005768 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005770 }
5771
5772 return 0;
5773}
5774
Valerio Setti67419f02023-01-04 16:12:42 +01005775#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005776static const struct {
5777 uint16_t tls_id;
5778 const char *name;
5779} tls_id_curve_name_table[] =
5780{
Valerio Setti54e23792023-07-07 10:49:27 +02005781 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5782 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5783 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5784 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5785 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5786 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5787 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5788 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5789 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5790 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5791 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5792 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5793 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005794 { 0, NULL },
5795};
5796
Gilles Peskine449bd832023-01-11 14:50:10 +01005797const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005798{
Valerio Settiacd32c02023-06-29 18:06:29 +02005799 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5800 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5801 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005803 }
5804
5805 return NULL;
5806}
Valerio Setti67419f02023-01-04 16:12:42 +01005807#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005810int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5811 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5812 int cert_endpoint,
5813 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005814{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005815 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005816 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005817 const char *ext_oid;
5818 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005819
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005821 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823 case MBEDTLS_KEY_EXCHANGE_RSA:
5824 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005825 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005826 break;
5827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005828 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5829 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5830 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5831 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005832 break;
5833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005834 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5835 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005836 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005837 break;
5838
5839 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005840 case MBEDTLS_KEY_EXCHANGE_NONE:
5841 case MBEDTLS_KEY_EXCHANGE_PSK:
5842 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5843 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005844 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005845 usage = 0;
5846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005848 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5849 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005850 }
5851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005853 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005854 ret = -1;
5855 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005858 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5860 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005861 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005863 }
5864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005866 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005867 ret = -1;
5868 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005871}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005872#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005873
Jerry Yu148165c2021-09-24 23:20:59 +08005874#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005875int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5876 const mbedtls_md_type_t md,
5877 unsigned char *dst,
5878 size_t dst_len,
5879 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005880{
Ronald Cronf6893e12022-01-07 22:09:01 +01005881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5882 psa_hash_operation_t *hash_operation_to_clone;
5883 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5884
Jerry Yu148165c2021-09-24 23:20:59 +08005885 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005886
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005888#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 case MBEDTLS_MD_SHA384:
5890 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5891 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005892#endif
5893
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005894#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 case MBEDTLS_MD_SHA256:
5896 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5897 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005898#endif
5899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 default:
5901 goto exit;
5902 }
5903
5904 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5905 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005906 goto exit;
5907 }
5908
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5910 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005911 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005913
5914exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005915#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5916 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005917 (void) ssl;
5918#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005919 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005920}
5921#else /* MBEDTLS_USE_PSA_CRYPTO */
5922
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005923#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005924MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005925static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5926 unsigned char *dst,
5927 size_t dst_len,
5928 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005929{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005930 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005931 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 if (dst_len < 48) {
5934 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5935 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005936
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005937 mbedtls_md_init(&sha384);
5938 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005939 if (ret != 0) {
5940 goto exit;
5941 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005942 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005943 if (ret != 0) {
5944 goto exit;
5945 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005946
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005947 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005948 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005949 goto exit;
5950 }
5951
5952 *olen = 48;
5953
5954exit:
5955
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005956 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005958}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005959#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005960
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005961#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005962MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005963static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5964 unsigned char *dst,
5965 size_t dst_len,
5966 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005967{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005968 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005969 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (dst_len < 32) {
5972 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5973 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005974
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005975 mbedtls_md_init(&sha256);
5976 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5977 if (ret != 0) {
5978 goto exit;
5979 }
5980 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5981 if (ret != 0) {
5982 goto exit;
5983 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005984
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005985 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5986 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005987 goto exit;
5988 }
5989
5990 *olen = 32;
5991
5992exit:
5993
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005994 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005996}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005997#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6000 const mbedtls_md_type_t md,
6001 unsigned char *dst,
6002 size_t dst_len,
6003 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006004{
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006006
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006007#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 case MBEDTLS_MD_SHA384:
6009 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006010#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006011
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006012#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 case MBEDTLS_MD_SHA256:
6014 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006015#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006018#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6019 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 (void) ssl;
6021 (void) dst;
6022 (void) dst_len;
6023 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006024#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006026 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006028}
XiaokangQian647719a2021-12-07 09:16:29 +00006029
Jerry Yu148165c2021-09-24 23:20:59 +08006030#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006031
Ronald Crone68ab4f2022-10-05 12:46:29 +02006032#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006033/* mbedtls_ssl_parse_sig_alg_ext()
6034 *
6035 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6036 * value (TLS 1.3 RFC8446):
6037 * enum {
6038 * ....
6039 * ecdsa_secp256r1_sha256( 0x0403 ),
6040 * ecdsa_secp384r1_sha384( 0x0503 ),
6041 * ecdsa_secp521r1_sha512( 0x0603 ),
6042 * ....
6043 * } SignatureScheme;
6044 *
6045 * struct {
6046 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6047 * } SignatureSchemeList;
6048 *
6049 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6050 * value (TLS 1.2 RFC5246):
6051 * enum {
6052 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6053 * sha512(6), (255)
6054 * } HashAlgorithm;
6055 *
6056 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6057 * SignatureAlgorithm;
6058 *
6059 * struct {
6060 * HashAlgorithm hash;
6061 * SignatureAlgorithm signature;
6062 * } SignatureAndHashAlgorithm;
6063 *
6064 * SignatureAndHashAlgorithm
6065 * supported_signature_algorithms<2..2^16-2>;
6066 *
6067 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6068 * generalization of the TLS 1.2 signature algorithm extension.
6069 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6070 * `SignatureScheme` field of TLS 1.3
6071 *
6072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006073int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6074 const unsigned char *buf,
6075 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006076{
6077 const unsigned char *p = buf;
6078 size_t supported_sig_algs_len = 0;
6079 const unsigned char *supported_sig_algs_end;
6080 uint16_t sig_alg;
6081 uint32_t common_idx = 0;
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6084 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006085 p += 2;
6086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 memset(ssl->handshake->received_sig_algs, 0,
6088 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006089
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006091 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 while (p < supported_sig_algs_end) {
6093 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6094 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006095 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6097 sig_alg,
6098 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006099#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6101 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6102 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006103 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006104 }
6105#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6108 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006111 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6112 common_idx += 1;
6113 }
6114 }
6115 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (p != end) {
6117 MBEDTLS_SSL_DEBUG_MSG(1,
6118 ("Signature algorithms extension length misaligned"));
6119 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6120 MBEDTLS_ERR_SSL_DECODE_ERROR);
6121 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006122 }
6123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (common_idx == 0) {
6125 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6126 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6127 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6128 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006129 }
6130
Gabor Mezei15b95a62022-05-09 16:37:58 +02006131 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006133}
6134
Ronald Crone68ab4f2022-10-05 12:46:29 +02006135#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006136
Jerry Yudc7bd172022-02-17 13:44:15 +08006137#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6138
6139#if defined(MBEDTLS_USE_PSA_CRYPTO)
6140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6142 mbedtls_svc_key_id_t key,
6143 psa_algorithm_t alg,
6144 const unsigned char *raw_psk, size_t raw_psk_length,
6145 const unsigned char *seed, size_t seed_length,
6146 const unsigned char *label, size_t label_length,
6147 const unsigned char *other_secret,
6148 size_t other_secret_length,
6149 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006150{
6151 psa_status_t status;
6152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 status = psa_key_derivation_setup(derivation, alg);
6154 if (status != PSA_SUCCESS) {
6155 return status;
6156 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6159 status = psa_key_derivation_input_bytes(derivation,
6160 PSA_KEY_DERIVATION_INPUT_SEED,
6161 seed, seed_length);
6162 if (status != PSA_SUCCESS) {
6163 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006164 }
6165
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 if (other_secret != NULL) {
6167 status = psa_key_derivation_input_bytes(derivation,
6168 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6169 other_secret, other_secret_length);
6170 if (status != PSA_SUCCESS) {
6171 return status;
6172 }
6173 }
6174
6175 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006176 status = psa_key_derivation_input_bytes(
6177 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 raw_psk, raw_psk_length);
6179 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006182 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 if (status != PSA_SUCCESS) {
6184 return status;
6185 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006186
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 status = psa_key_derivation_input_bytes(derivation,
6188 PSA_KEY_DERIVATION_INPUT_LABEL,
6189 label, label_length);
6190 if (status != PSA_SUCCESS) {
6191 return status;
6192 }
6193 } else {
6194 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006195 }
6196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 status = psa_key_derivation_set_capacity(derivation, capacity);
6198 if (status != PSA_SUCCESS) {
6199 return status;
6200 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006203}
6204
Andrzej Kurek57d10632022-10-24 10:32:01 -04006205#if defined(PSA_WANT_ALG_SHA_384) || \
6206 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006207MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006208static int tls_prf_generic(mbedtls_md_type_t md_type,
6209 const unsigned char *secret, size_t slen,
6210 const char *label,
6211 const unsigned char *random, size_t rlen,
6212 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006213{
6214 psa_status_t status;
6215 psa_algorithm_t alg;
6216 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6217 psa_key_derivation_operation_t derivation =
6218 PSA_KEY_DERIVATION_OPERATION_INIT;
6219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006223 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225
6226 /* Normally a "secret" should be long enough to be impossible to
6227 * find by brute force, and in particular should not be empty. But
6228 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6229 * and for this use case it makes sense to have a 0-length "secret".
6230 * Since the key API doesn't allow importing a key of length 0,
6231 * keep master_key=0, which setup_psa_key_derivation() understands
6232 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006234 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6236 psa_set_key_algorithm(&key_attributes, alg);
6237 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6240 if (status != PSA_SUCCESS) {
6241 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6242 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006243 }
6244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 status = setup_psa_key_derivation(&derivation,
6246 master_key, alg,
6247 NULL, 0,
6248 random, rlen,
6249 (unsigned char const *) label,
6250 (size_t) strlen(label),
6251 NULL, 0,
6252 dlen);
6253 if (status != PSA_SUCCESS) {
6254 psa_key_derivation_abort(&derivation);
6255 psa_destroy_key(master_key);
6256 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006257 }
6258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6260 if (status != PSA_SUCCESS) {
6261 psa_key_derivation_abort(&derivation);
6262 psa_destroy_key(master_key);
6263 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 }
6265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 status = psa_key_derivation_abort(&derivation);
6267 if (status != PSA_SUCCESS) {
6268 psa_destroy_key(master_key);
6269 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006270 }
6271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 if (!mbedtls_svc_key_id_is_null(master_key)) {
6273 status = psa_destroy_key(master_key);
6274 }
6275 if (status != PSA_SUCCESS) {
6276 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6277 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006280}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006281#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006282#else /* MBEDTLS_USE_PSA_CRYPTO */
6283
Andrzej Kurek57d10632022-10-24 10:32:01 -04006284#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006285 (defined(MBEDTLS_MD_CAN_SHA256) || \
6286 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006288static int tls_prf_generic(mbedtls_md_type_t md_type,
6289 const unsigned char *secret, size_t slen,
6290 const char *label,
6291 const unsigned char *random, size_t rlen,
6292 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006293{
6294 size_t nb;
6295 size_t i, j, k, md_len;
6296 unsigned char *tmp;
6297 size_t tmp_len = 0;
6298 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6299 const mbedtls_md_info_t *md_info;
6300 mbedtls_md_context_t md_ctx;
6301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6302
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006304
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6306 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6307 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006308
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006310
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 tmp_len = md_len + strlen(label) + rlen;
6312 tmp = mbedtls_calloc(1, tmp_len);
6313 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006314 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6315 goto exit;
6316 }
6317
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 nb = strlen(label);
6319 memcpy(tmp + md_len, label, nb);
6320 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006321 nb += rlen;
6322
6323 /*
6324 * Compute P_<hash>(secret, label + random)[0..dlen]
6325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006327 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006329
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6331 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006332 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 }
6334 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6335 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006336 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 }
6338 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6339 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006340 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 for (i = 0; i < dlen; i += md_len) {
6344 ret = mbedtls_md_hmac_reset(&md_ctx);
6345 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006346 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 }
6348 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6349 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006350 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 }
6352 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6353 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006354 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 ret = mbedtls_md_hmac_reset(&md_ctx);
6358 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006359 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 }
6361 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6362 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006363 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 }
6365 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6366 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006373 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006375 }
6376
6377exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (tmp != NULL) {
6381 mbedtls_platform_zeroize(tmp, tmp_len);
6382 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006389}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006390#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006391#endif /* MBEDTLS_USE_PSA_CRYPTO */
6392
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006393#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006395static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6396 const char *label,
6397 const unsigned char *random, size_t rlen,
6398 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006399{
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6401 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006402}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006403#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006404
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006405#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006407static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6408 const char *label,
6409 const unsigned char *random, size_t rlen,
6410 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006411{
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6413 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006414}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006415#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006416
Jerry Yuf009d862022-02-17 14:01:37 +08006417/*
6418 * Set appropriate PRF function and other SSL / TLS1.2 functions
6419 *
6420 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006421 * - hash associated with the ciphersuite (only used by TLS 1.2)
6422 *
6423 * Outputs:
6424 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6425 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006427static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6428 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006429{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006430#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006432 handshake->tls_prf = tls_prf_sha384;
6433 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6434 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006436#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006437#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006438 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006439 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006440 handshake->tls_prf = tls_prf_sha256;
6441 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6442 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6443 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006444#else
Jerry Yuf009d862022-02-17 14:01:37 +08006445 {
Jerry Yuf009d862022-02-17 14:01:37 +08006446 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006447 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006449 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006450#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006453}
Jerry Yud6ab2352022-02-17 14:03:43 +08006454
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455/*
6456 * Compute master secret if needed
6457 *
6458 * Parameters:
6459 * [in/out] handshake
6460 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6461 * (PSA-PSK) ciphersuite_info, psk_opaque
6462 * [out] premaster (cleared)
6463 * [out] master
6464 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6465 * debug: conf->f_dbg, conf->p_dbg
6466 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006467 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006468 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006470static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6471 unsigned char *master,
6472 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473{
6474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6475
6476 /* cf. RFC 5246, Section 8.1:
6477 * "The master secret is always exactly 48 bytes in length." */
6478 size_t const master_secret_len = 48;
6479
6480#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6481 unsigned char session_hash[48];
6482#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6483
6484 /* The label for the KDF used for key expansion.
6485 * This is either "master secret" or "extended master secret"
6486 * depending on whether the Extended Master Secret extension
6487 * is used. */
6488 char const *lbl = "master secret";
6489
Przemek Stekielae4ed302022-04-05 17:15:55 +02006490 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006491 * - If the Extended Master Secret extension is not used,
6492 * this is ClientHello.Random + ServerHello.Random
6493 * (see Sect. 8.1 in RFC 5246).
6494 * - If the Extended Master Secret extension is used,
6495 * this is the transcript of the handshake so far.
6496 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006497 unsigned char const *seed = handshake->randbytes;
6498 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006499
6500#if !defined(MBEDTLS_DEBUG_C) && \
6501 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6502 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006504 ssl = NULL; /* make sure we don't use it except for those cases */
6505 (void) ssl;
6506#endif
6507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (handshake->resume != 0) {
6509 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6510 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006511 }
6512
6513#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006515 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006516 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006517 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6518 if (ret != 0) {
6519 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6520 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6523 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006524 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006525#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526
Przemek Stekiel99114f32022-04-22 11:20:09 +02006527#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006528 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006530 /* Perform PSK-to-MS expansion in a single step. */
6531 psa_status_t status;
6532 psa_algorithm_t alg;
6533 mbedtls_svc_key_id_t psk;
6534 psa_key_derivation_operation_t derivation =
6535 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006536 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006543 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006545 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006547
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006548 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006552 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006553 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006554 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006555 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006556 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006557 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006558 other_secret_len = 48;
6559 other_secret = handshake->premaster + 2;
6560 break;
6561 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006562 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006563 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6564 other_secret = handshake->premaster + 2;
6565 break;
6566 default:
6567 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006568 }
6569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 status = setup_psa_key_derivation(&derivation, psk, alg,
6571 ssl->conf->psk, ssl->conf->psk_len,
6572 seed, seed_len,
6573 (unsigned char const *) lbl,
6574 (size_t) strlen(lbl),
6575 other_secret, other_secret_len,
6576 master_secret_len);
6577 if (status != PSA_SUCCESS) {
6578 psa_key_derivation_abort(&derivation);
6579 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006580 }
6581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 status = psa_key_derivation_output_bytes(&derivation,
6583 master,
6584 master_secret_len);
6585 if (status != PSA_SUCCESS) {
6586 psa_key_derivation_abort(&derivation);
6587 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006588 }
6589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 status = psa_key_derivation_abort(&derivation);
6591 if (status != PSA_SUCCESS) {
6592 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6593 }
6594 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006595#endif
6596 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006597#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6599 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006600 psa_status_t status;
6601 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6602 psa_key_derivation_operation_t derivation =
6603 PSA_KEY_DERIVATION_OPERATION_INIT;
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006606
6607 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 status = psa_key_derivation_setup(&derivation, alg);
6610 if (status != PSA_SUCCESS) {
6611 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006612 }
6613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 status = psa_key_derivation_set_capacity(&derivation,
6615 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6616 if (status != PSA_SUCCESS) {
6617 psa_key_derivation_abort(&derivation);
6618 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006619 }
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6622 &derivation);
6623 if (status != PSA_SUCCESS) {
6624 psa_key_derivation_abort(&derivation);
6625 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006626 }
6627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 status = psa_key_derivation_output_bytes(&derivation,
6629 handshake->premaster,
6630 handshake->pmslen);
6631 if (status != PSA_SUCCESS) {
6632 psa_key_derivation_abort(&derivation);
6633 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6634 }
6635
6636 status = psa_key_derivation_abort(&derivation);
6637 if (status != PSA_SUCCESS) {
6638 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006639 }
6640 }
6641#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6643 lbl, seed, seed_len,
6644 master,
6645 master_secret_len);
6646 if (ret != 0) {
6647 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6648 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006649 }
6650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6652 handshake->premaster,
6653 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006654
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 mbedtls_platform_zeroize(handshake->premaster,
6656 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006657 }
6658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006660}
6661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006663{
6664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6665 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6666 ssl->handshake->ciphersuite_info;
6667
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006669
6670 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006672 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 if (ret != 0) {
6674 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6675 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006676 }
6677
6678 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 ret = ssl_compute_master(ssl->handshake,
6680 ssl->session_negotiate->master,
6681 ssl);
6682 if (ret != 0) {
6683 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6684 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006685 }
6686
6687 /* Swap the client and server random values:
6688 * - MS derivation wanted client+server (RFC 5246 8.1)
6689 * - key derivation wants server+client (RFC 5246 6.3) */
6690 {
6691 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 memcpy(tmp, ssl->handshake->randbytes, 64);
6693 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6694 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6695 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006696 }
6697
6698 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6700 ssl->session_negotiate->ciphersuite,
6701 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006702#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006704#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 ssl->handshake->tls_prf,
6706 ssl->handshake->randbytes,
6707 ssl->tls_version,
6708 ssl->conf->endpoint,
6709 ssl);
6710 if (ret != 0) {
6711 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6712 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006713 }
6714
6715 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6717 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006718
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006722}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006725{
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006727#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006728 case MBEDTLS_SSL_HASH_SHA384:
6729 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6730 break;
6731#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006732#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006733 case MBEDTLS_SSL_HASH_SHA256:
6734 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6735 break;
6736#endif
6737 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006739 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006740#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6741 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006742 (void) ssl;
6743#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006745}
6746
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006747#if defined(MBEDTLS_USE_PSA_CRYPTO)
6748static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6749 const psa_hash_operation_t *hs_op,
6750 size_t buffer_size,
6751 unsigned char *hash,
6752 size_t *hlen)
6753{
6754 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006755 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006756
6757#if !defined(MBEDTLS_DEBUG_C)
6758 (void) ssl;
6759#endif
6760 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006761 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006762 if (status != PSA_SUCCESS) {
6763 goto exit;
6764 }
6765
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006766 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006767 if (status != PSA_SUCCESS) {
6768 goto exit;
6769 }
6770
6771 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6772 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6773
6774exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006775 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006776 return mbedtls_md_error_from_psa(status);
6777}
6778#else
6779static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6780 const mbedtls_md_context_t *hs_ctx,
6781 unsigned char *hash,
6782 size_t *hlen)
6783{
6784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006785 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006786
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006787 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006788
6789#if !defined(MBEDTLS_DEBUG_C)
6790 (void) ssl;
6791#endif
6792 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6793
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006794 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006795 if (ret != 0) {
6796 goto exit;
6797 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006798 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006799 if (ret != 0) {
6800 goto exit;
6801 }
6802
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006803 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006804 if (ret != 0) {
6805 goto exit;
6806 }
6807
6808 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6809
6810 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6811 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6812
6813exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006814 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006815 return ret;
6816}
6817#endif /* MBEDTLS_USE_PSA_CRYPTO */
6818
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006819#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006820int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6821 unsigned char *hash,
6822 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006823{
6824#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006825 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6826 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006827#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006828 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6829 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006830#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006831}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006832#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006833
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006834#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006835int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6836 unsigned char *hash,
6837 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006838{
6839#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006840 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6841 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006842#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006843 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6844 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006845#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006846}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006847#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006848
Neil Armstrong80f6f322022-05-03 17:56:38 +02006849#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6850 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006851int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006852{
6853 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006855 const unsigned char *psk = NULL;
6856 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006860 /*
6861 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006862 * checked before calling this function.
6863 *
6864 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006865 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6868 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6869 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006870 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006871 }
6872
6873 /*
6874 * PMS = struct {
6875 * opaque other_secret<0..2^16-1>;
6876 * opaque psk<0..2^16-1>;
6877 * };
6878 * with "other_secret" depending on the particular key exchange
6879 */
6880#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6882 if (end - p < 2) {
6883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6884 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006885
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006887 p += 2;
6888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (end < p || (size_t) (end - p) < psk_len) {
6890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6891 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006894 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006896#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6897#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006899 /*
6900 * other_secret already set by the ClientKeyExchange message,
6901 * and is 48 bytes long
6902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if (end - p < 2) {
6904 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6905 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006906
6907 *p++ = 0;
6908 *p++ = 48;
6909 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006911#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6912#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6915 size_t len;
6916
6917 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006919 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6921 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6922 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006923 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006925 p += 2 + len;
6926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6928 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006929#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006930#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6933 size_t zlen;
6934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006936 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6938 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6939 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006940 }
6941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006943 p += 2 + zlen;
6944
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6946 MBEDTLS_DEBUG_ECDH_Z);
6947 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006948#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006949 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6951 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006952 }
6953
6954 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (end - p < 2) {
6956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6957 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006960 p += 2;
6961
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 if (end < p || (size_t) (end - p) < psk_len) {
6963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6964 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006967 p += psk_len;
6968
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006969 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006972}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006973#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006974
6975#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006976MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006977static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006978
6979#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006980int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006981{
6982 /* If renegotiation is not enforced, retransmit until we would reach max
6983 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006985 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6986 unsigned char doublings = 1;
6987
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006989 ++doublings;
6990 ratio >>= 1;
6991 }
6992
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 if (++ssl->renego_records_seen > doublings) {
6994 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6995 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006996 }
6997 }
6998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007000}
7001#endif
7002#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007003
Jerry Yud9526692022-02-17 14:23:47 +08007004/*
7005 * Handshake functions
7006 */
7007#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7008/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007009int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007010{
7011 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7012 ssl->handshake->ciphersuite_info;
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7017 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007018 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007020 }
7021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7023 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007024}
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007027{
7028 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7029 ssl->handshake->ciphersuite_info;
7030
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7034 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007035 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007037 }
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7040 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007041}
7042
7043#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7044/* Some certificate support -> implement write and parse */
7045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007047{
7048 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7049 size_t i, n;
7050 const mbedtls_x509_crt *crt;
7051 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7052 ssl->handshake->ciphersuite_info;
7053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7057 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007058 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007060 }
7061
7062#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7064 if (ssl->handshake->client_auth == 0) {
7065 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007066 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007068 }
7069 }
7070#endif /* MBEDTLS_SSL_CLI_C */
7071#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7073 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007074 /* Should never happen because we shouldn't have picked the
7075 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007077 }
7078 }
7079#endif
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007082
7083 /*
7084 * 0 . 0 handshake type
7085 * 1 . 3 handshake length
7086 * 4 . 6 length of all certs
7087 * 7 . 9 length of cert. 1
7088 * 10 . n-1 peer certificate
7089 * n . n+2 length of cert. 2
7090 * n+3 . ... upper level cert, etc.
7091 */
7092 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007094
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007096 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7098 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7099 " > %" MBEDTLS_PRINTF_SIZET,
7100 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7101 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007102 }
7103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7105 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7106 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007109 i += n; crt = crt->next;
7110 }
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7113 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7114 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007115
7116 ssl->out_msglen = i;
7117 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7118 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7119
7120 ssl->state++;
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7124 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007125 }
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007130}
7131
7132#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7133
7134#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007135MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007136static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7137 unsigned char *crt_buf,
7138 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007139{
7140 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 if (peer_crt == NULL) {
7143 return -1;
7144 }
Jerry Yud9526692022-02-17 14:23:47 +08007145
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 if (peer_crt->raw.len != crt_buf_len) {
7147 return -1;
7148 }
Jerry Yud9526692022-02-17 14:23:47 +08007149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007151}
7152#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007154static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7155 unsigned char *crt_buf,
7156 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007157{
7158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7159 unsigned char const * const peer_cert_digest =
7160 ssl->session->peer_cert_digest;
7161 mbedtls_md_type_t const peer_cert_digest_type =
7162 ssl->session->peer_cert_digest_type;
7163 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007165 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7166 size_t digest_len;
7167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 if (peer_cert_digest == NULL || digest_info == NULL) {
7169 return -1;
7170 }
Jerry Yud9526692022-02-17 14:23:47 +08007171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 digest_len = mbedtls_md_get_size(digest_info);
7173 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7174 return -1;
7175 }
Jerry Yud9526692022-02-17 14:23:47 +08007176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7178 if (ret != 0) {
7179 return -1;
7180 }
Jerry Yud9526692022-02-17 14:23:47 +08007181
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007183}
7184#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7185#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7186
7187/*
7188 * Once the certificate message is read, parse it into a cert chain and
7189 * perform basic checks, but leave actual verification to the caller
7190 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007192static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7193 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007194{
7195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7196#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007198#endif
7199 size_t i, n;
7200 uint8_t alert;
7201
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7203 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7204 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7205 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7206 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007207 }
7208
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7210 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7211 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7212 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007213 }
7214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7216 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7217 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7218 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7219 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007220 }
7221
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007223
7224 /*
7225 * Same message structure as in mbedtls_ssl_write_certificate()
7226 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007227 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007228
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 if (ssl->in_msg[i] != 0 ||
7230 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7231 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7232 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7233 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7234 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007235 }
7236
7237 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7238 i += 3;
7239
7240 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007242 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 if (i + 3 > ssl->in_hslen) {
7244 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7245 mbedtls_ssl_send_alert_message(ssl,
7246 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7247 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7248 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007249 }
7250 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7251 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (ssl->in_msg[i] != 0) {
7253 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7254 mbedtls_ssl_send_alert_message(ssl,
7255 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7256 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7257 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007258 }
7259
7260 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007261 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007262 i += 3;
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (n < 128 || i + n > ssl->in_hslen) {
7265 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7266 mbedtls_ssl_send_alert_message(ssl,
7267 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7268 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7269 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007270 }
7271
7272 /* Check if we're handling the first CRT in the chain. */
7273#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007275 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007277 /* During client-side renegotiation, check that the server's
7278 * end-CRTs hasn't changed compared to the initial handshake,
7279 * mitigating the triple handshake attack. On success, reuse
7280 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7282 if (ssl_check_peer_crt_unchanged(ssl,
7283 &ssl->in_msg[i],
7284 n) != 0) {
7285 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7286 mbedtls_ssl_send_alert_message(ssl,
7287 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7288 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7289 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007290 }
7291
7292 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007294 }
7295#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7296
7297 /* Parse the next certificate in the chain. */
7298#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007300#else
7301 /* If we don't need to store the CRT chain permanently, parse
7302 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007304#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007306 case 0: /*ok*/
7307 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7308 /* Ignore certificate with an unknown algorithm: maybe a
7309 prior certificate was already trusted. */
7310 break;
7311
7312 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7313 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7314 goto crt_parse_der_failed;
7315
7316 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7317 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7318 goto crt_parse_der_failed;
7319
7320 default:
7321 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007322crt_parse_der_failed:
7323 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7324 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7325 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007326 }
7327
7328 i += n;
7329 }
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7332 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007333}
7334
7335#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007337static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007338{
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7340 return -1;
7341 }
Jerry Yud9526692022-02-17 14:23:47 +08007342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007344 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7345 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7347 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7348 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007349 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007351}
7352#endif /* MBEDTLS_SSL_SRV_C */
7353
7354/* Check if a certificate message is expected.
7355 * Return either
7356 * - SSL_CERTIFICATE_EXPECTED, or
7357 * - SSL_CERTIFICATE_SKIP
7358 * indicating whether a Certificate message is expected or not.
7359 */
7360#define SSL_CERTIFICATE_EXPECTED 0
7361#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007362MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007363static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7364 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007365{
7366 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7367 ssl->handshake->ciphersuite_info;
7368
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7370 return SSL_CERTIFICATE_SKIP;
7371 }
Jerry Yud9526692022-02-17 14:23:47 +08007372
7373#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7375 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7376 return SSL_CERTIFICATE_SKIP;
7377 }
Jerry Yud9526692022-02-17 14:23:47 +08007378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007380 ssl->session_negotiate->verify_result =
7381 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007383 }
7384 }
7385#else
7386 ((void) authmode);
7387#endif /* MBEDTLS_SSL_SRV_C */
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007390}
7391
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007393static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7394 int authmode,
7395 mbedtls_x509_crt *chain,
7396 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007397{
7398 int ret = 0;
7399 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7400 ssl->handshake->ciphersuite_info;
7401 int have_ca_chain = 0;
7402
7403 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7404 void *p_vrfy;
7405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7407 return 0;
7408 }
Jerry Yud9526692022-02-17 14:23:47 +08007409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 if (ssl->f_vrfy != NULL) {
7411 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007412 f_vrfy = ssl->f_vrfy;
7413 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 } else {
7415 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007416 f_vrfy = ssl->conf->f_vrfy;
7417 p_vrfy = ssl->conf->p_vrfy;
7418 }
7419
7420 /*
7421 * Main check: verify certificate
7422 */
7423#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007425 ((void) rs_ctx);
7426 have_ca_chain = 1;
7427
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007429 ret = mbedtls_x509_crt_verify_with_ca_cb(
7430 chain,
7431 ssl->conf->f_ca_cb,
7432 ssl->conf->p_ca_cb,
7433 ssl->conf->cert_profile,
7434 ssl->hostname,
7435 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 f_vrfy, p_vrfy);
7437 } else
Jerry Yud9526692022-02-17 14:23:47 +08007438#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7439 {
7440 mbedtls_x509_crt *ca_chain;
7441 mbedtls_x509_crl *ca_crl;
7442
7443#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007445 ca_chain = ssl->handshake->sni_ca_chain;
7446 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 } else
Jerry Yud9526692022-02-17 14:23:47 +08007448#endif
7449 {
7450 ca_chain = ssl->conf->ca_chain;
7451 ca_crl = ssl->conf->ca_crl;
7452 }
7453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007455 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 }
Jerry Yud9526692022-02-17 14:23:47 +08007457
7458 ret = mbedtls_x509_crt_verify_restartable(
7459 chain,
7460 ca_chain, ca_crl,
7461 ssl->conf->cert_profile,
7462 ssl->hostname,
7463 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007465 }
7466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if (ret != 0) {
7468 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007469 }
7470
7471#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7473 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7474 }
Jerry Yud9526692022-02-17 14:23:47 +08007475#endif
7476
7477 /*
7478 * Secondary checks: always done, but change 'ret' only if it was 0
7479 */
7480
Valerio Settiacd32c02023-06-29 18:06:29 +02007481#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007482 {
7483 const mbedtls_pk_context *pk = &chain->pk;
7484
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007485 /* If certificate uses an EC key, make sure the curve is OK.
7486 * This is a public key, so it can't be opaque, so can_do() is a good
7487 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007489 /* and in the unlikely case the above assumption no longer holds
7490 * we are making sure that pk_ec() here does not return a NULL
7491 */
Valerio Settif9362b72023-11-29 08:42:27 +01007492 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007493 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7494 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007496 }
Valerio Setti97207782023-05-18 18:59:06 +02007497 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007498 ssl->session_negotiate->verify_result |=
7499 MBEDTLS_X509_BADCERT_BAD_KEY;
7500
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7502 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007503 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007505 }
Jerry Yud9526692022-02-17 14:23:47 +08007506 }
7507 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007508#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (mbedtls_ssl_check_cert_usage(chain,
7511 ciphersuite_info,
7512 !ssl->conf->endpoint,
7513 &ssl->session_negotiate->verify_result) != 0) {
7514 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7515 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007516 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 }
Jerry Yud9526692022-02-17 14:23:47 +08007518 }
7519
7520 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7521 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7522 * with details encoded in the verification flags. All other kinds
7523 * of error codes, including those from the user provided f_vrfy
7524 * functions, are treated as fatal and lead to a failure of
7525 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7527 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7528 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007529 ret = 0;
7530 }
7531
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7533 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007534 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7535 }
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007538 uint8_t alert;
7539
7540 /* The certificate may have been rejected for several reasons.
7541 Pick one and send the corresponding alert. Which alert to send
7542 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007544 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007546 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007548 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007550 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007552 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007554 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007556 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007558 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007560 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007562 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007564 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 }
7566 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7567 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007568 }
7569
7570#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 if (ssl->session_negotiate->verify_result != 0) {
7572 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7573 (unsigned int) ssl->session_negotiate->verify_result));
7574 } else {
7575 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007576 }
7577#endif /* MBEDTLS_DEBUG_C */
7578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007580}
7581
7582#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007583MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007584static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7585 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007586{
7587 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7588 /* Remember digest of the peer's end-CRT. */
7589 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7591 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7592 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7593 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7594 mbedtls_ssl_send_alert_message(ssl,
7595 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7596 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007599 }
7600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 ret = mbedtls_md(mbedtls_md_info_from_type(
7602 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7603 start, len,
7604 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007605
7606 ssl->session_negotiate->peer_cert_digest_type =
7607 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7608 ssl->session_negotiate->peer_cert_digest_len =
7609 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7610
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007612}
7613
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007614MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007615static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7616 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007617{
7618 unsigned char *end = start + len;
7619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7620
7621 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7623 ret = mbedtls_pk_parse_subpubkey(&start, end,
7624 &ssl->handshake->peer_pubkey);
7625 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007626 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007628 }
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007631}
7632#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007635{
7636 int ret = 0;
7637 int crt_expected;
7638#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7639 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7640 ? ssl->handshake->sni_authmode
7641 : ssl->conf->authmode;
7642#else
7643 const int authmode = ssl->conf->authmode;
7644#endif
7645 void *rs_ctx = NULL;
7646 mbedtls_x509_crt *chain = NULL;
7647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7651 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7652 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007653 goto exit;
7654 }
7655
7656#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (ssl->handshake->ecrs_enabled &&
7658 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 chain = ssl->handshake->ecrs_peer_cert;
7660 ssl->handshake->ecrs_peer_cert = NULL;
7661 goto crt_verify;
7662 }
7663#endif
7664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007666 /* mbedtls_ssl_read_record may have sent an alert already. We
7667 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007669 goto exit;
7670 }
7671
7672#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007674 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007677 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 }
Jerry Yud9526692022-02-17 14:23:47 +08007679
7680 goto exit;
7681 }
7682#endif /* MBEDTLS_SSL_SRV_C */
7683
7684 /* Clear existing peer CRT structure in case we tried to
7685 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7689 if (chain == NULL) {
7690 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7691 sizeof(mbedtls_x509_crt)));
7692 mbedtls_ssl_send_alert_message(ssl,
7693 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7694 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007695
7696 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7697 goto exit;
7698 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 ret = ssl_parse_certificate_chain(ssl, chain);
7702 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007703 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 }
Jerry Yud9526692022-02-17 14:23:47 +08007705
7706#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007708 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 }
Jerry Yud9526692022-02-17 14:23:47 +08007710
7711crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007713 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 }
Jerry Yud9526692022-02-17 14:23:47 +08007715#endif
7716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 ret = ssl_parse_certificate_verify(ssl, authmode,
7718 chain, rs_ctx);
7719 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007720 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 }
Jerry Yud9526692022-02-17 14:23:47 +08007722
7723#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7724 {
7725 unsigned char *crt_start, *pk_start;
7726 size_t crt_len, pk_len;
7727
7728 /* We parse the CRT chain without copying, so
7729 * these pointers point into the input buffer,
7730 * and are hence still valid after freeing the
7731 * CRT chain. */
7732
7733 crt_start = chain->raw.p;
7734 crt_len = chain->raw.len;
7735
7736 pk_start = chain->pk_raw.p;
7737 pk_len = chain->pk_raw.len;
7738
7739 /* Free the CRT structures before computing
7740 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 mbedtls_x509_crt_free(chain);
7742 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007743 chain = NULL;
7744
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7746 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007747 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 }
Jerry Yud9526692022-02-17 14:23:47 +08007749
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7751 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007752 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 }
Jerry Yud9526692022-02-17 14:23:47 +08007754 }
7755#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7756 /* Pass ownership to session structure. */
7757 ssl->session_negotiate->peer_cert = chain;
7758 chain = NULL;
7759#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007762
7763exit:
7764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007766 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 }
Jerry Yud9526692022-02-17 14:23:47 +08007768
7769#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007771 ssl->handshake->ecrs_peer_cert = chain;
7772 chain = NULL;
7773 }
7774#endif
7775
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (chain != NULL) {
7777 mbedtls_x509_crt_free(chain);
7778 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007779 }
7780
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007782}
7783#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7784
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007785static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7786 unsigned char *padbuf, size_t hlen,
7787 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007788{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007789 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007790 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007791#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007792 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007793 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007794 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007795 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007796#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007797 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007798 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007799 mbedtls_md_context_t cloned_ctx;
7800 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007801#endif
7802
7803 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007805 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007807
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007809 ? "client finished"
7810 : "server finished";
7811
7812#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007813 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007814
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007815 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007817 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007818 }
7819
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007820 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007822 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007823 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007824 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007825#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007826 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007827
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007828 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007829 if (ret != 0) {
7830 goto exit;
7831 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007832 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007833 if (ret != 0) {
7834 goto exit;
7835 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007836
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007837 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007838 if (ret != 0) {
7839 goto exit;
7840 }
7841#endif /* MBEDTLS_USE_PSA_CRYPTO */
7842
7843 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7844
Jerry Yu615bd6f2022-02-17 14:25:15 +08007845 /*
7846 * TLSv1.2:
7847 * hash = PRF( master, finished_label,
7848 * Hash( handshake ) )[0.11]
7849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007851 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007854
Paul Elliottecb95be2023-08-11 16:41:04 +01007855 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007856
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007857 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007858
7859exit:
7860#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007861 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007862 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007863#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007864 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007865 return ret;
7866#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007867}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007868
7869#if defined(MBEDTLS_MD_CAN_SHA256)
7870static int ssl_calc_finished_tls_sha256(
7871 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7872{
7873 unsigned char padbuf[32];
7874 return ssl_calc_finished_tls_generic(ssl,
7875#if defined(MBEDTLS_USE_PSA_CRYPTO)
7876 &ssl->handshake->fin_sha256_psa,
7877#else
7878 &ssl->handshake->fin_sha256,
7879#endif
7880 padbuf, sizeof(padbuf),
7881 buf, from);
7882}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007883#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007884
Jerry Yub7ba49e2022-02-17 14:25:53 +08007885
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007886#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007887static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007889{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007890 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007891 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007892#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007893 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007894#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007895 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007896#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007897 padbuf, sizeof(padbuf),
7898 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007899}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007900#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007901
Gilles Peskine449bd832023-01-11 14:50:10 +01007902void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007903{
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007905
7906 /*
7907 * Free our handshake params
7908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 mbedtls_ssl_handshake_free(ssl);
7910 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007911 ssl->handshake = NULL;
7912
7913 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007914 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (ssl->transform) {
7917 mbedtls_ssl_transform_free(ssl->transform);
7918 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007919 }
7920 ssl->transform = ssl->transform_negotiate;
7921 ssl->transform_negotiate = NULL;
7922
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007924}
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927{
7928 int resume = ssl->handshake->resume;
7929
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007931
7932#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7935 ssl->renego_records_seen = 0;
7936 }
7937#endif
7938
7939 /*
7940 * Free the previous session and switch in the current one
7941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007943#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7944 /* RFC 7366 3.1: keep the EtM state */
7945 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007947#endif
7948
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 mbedtls_ssl_session_free(ssl->session);
7950 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007951 }
7952 ssl->session = ssl->session_negotiate;
7953 ssl->session_negotiate = NULL;
7954
7955 /*
7956 * Add cache entry
7957 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007959 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 resume == 0) {
7961 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7962 ssl->session->id,
7963 ssl->session->id_len,
7964 ssl->session) != 0) {
7965 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7966 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007967 }
7968
7969#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7971 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007972 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007974
7975 /* Keep last flight around in case we need to resend it:
7976 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7978 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007979#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007981
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007982 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007983
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007985}
7986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007988{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007989 int ret;
7990 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007991
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007996 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7997 if (ret != 0) {
7998 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7999 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008000
8001 /*
8002 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8003 * may define some other value. Currently (early 2016), no defined
8004 * ciphersuite does this (and this is unlikely to change as activity has
8005 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8006 */
8007 hash_len = 12;
8008
8009#if defined(MBEDTLS_SSL_RENEGOTIATION)
8010 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012#endif
8013
8014 ssl->out_msglen = 4 + hash_len;
8015 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8016 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8017
8018 /*
8019 * In case of session resuming, invert the client and server
8020 * ChangeCipherSpec messages order.
8021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008023#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008025 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027#endif
8028#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008030 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008032#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008034 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008036
8037 /*
8038 * Switch to our negotiated transform and session parameters for outbound
8039 * data.
8040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008042
8043#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008045 unsigned char i;
8046
8047 /* Remember current epoch settings for resending */
8048 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8050 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008051
8052 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008054
8055
8056 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 for (i = 2; i > 0; i--) {
8058 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008059 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 }
8061 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008062
8063 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (i == 0) {
8065 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8066 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008067 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008069#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008071
8072 ssl->transform_out = ssl->transform_negotiate;
8073 ssl->session_out = ssl->session_negotiate;
8074
8075#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8077 mbedtls_ssl_send_flight_completed(ssl);
8078 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008079#endif
8080
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8082 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8083 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008084 }
8085
8086#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8088 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8089 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8090 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008091 }
8092#endif
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008095
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008097}
8098
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008099#define SSL_MAX_HASH_LEN 12
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008102{
8103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8104 unsigned int hash_len = 12;
8105 unsigned char buf[SSL_MAX_HASH_LEN];
8106
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008108
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008109 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8110 if (ret != 0) {
8111 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8112 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008113
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8115 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116 goto exit;
8117 }
8118
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8120 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8121 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8122 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008123 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8124 goto exit;
8125 }
8126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8128 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8129 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008130 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8131 goto exit;
8132 }
8133
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8135 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8136 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8137 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008138 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8139 goto exit;
8140 }
8141
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8143 buf, hash_len) != 0) {
8144 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8145 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8146 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008147 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8148 goto exit;
8149 }
8150
8151#if defined(MBEDTLS_SSL_RENEGOTIATION)
8152 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008154#endif
8155
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008157#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008159 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008161#endif
8162#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008164 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008166#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008168 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008170
8171#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8173 mbedtls_ssl_recv_flight_completed(ssl);
8174 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008175#endif
8176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008178
8179exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 mbedtls_platform_zeroize(buf, hash_len);
8181 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008182}
8183
Jerry Yu392112c2022-02-17 14:34:10 +08008184#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8185/*
8186 * Helper to get TLS 1.2 PRF from ciphersuite
8187 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008189static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008190{
Jerry Yu392112c2022-02-17 14:34:10 +08008191 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008193#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8195 return tls_prf_sha384;
8196 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008197#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008198#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008199 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8201 return tls_prf_sha256;
8202 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008203 }
8204#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008205#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8206 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008207 (void) ciphersuite_info;
8208#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008209
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008211}
8212#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008213
Gilles Peskine449bd832023-01-11 14:50:10 +01008214static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008215{
8216 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008217#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 if (tls_prf == tls_prf_sha384) {
8219 return MBEDTLS_SSL_TLS_PRF_SHA384;
8220 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008221#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008222#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 if (tls_prf == tls_prf_sha256) {
8224 return MBEDTLS_SSL_TLS_PRF_SHA256;
8225 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008228}
8229
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008230/*
8231 * Populate a transform structure with session keys and all the other
8232 * necessary information.
8233 *
8234 * Parameters:
8235 * - [in/out]: transform: structure to populate
8236 * [in] must be just initialised with mbedtls_ssl_transform_init()
8237 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8238 * - [in] ciphersuite
8239 * - [in] master
8240 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008241 * - [in] tls_prf: pointer to PRF to use for key derivation
8242 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008243 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008244 * - [in] endpoint: client or server
8245 * - [in] ssl: used for:
8246 * - ssl->conf->{f,p}_export_keys
8247 * [in] optionally used for:
8248 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8249 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008250MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008251static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8252 int ciphersuite,
8253 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008254#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008256#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 ssl_tls_prf_t tls_prf,
8258 const unsigned char randbytes[64],
8259 mbedtls_ssl_protocol_version tls_version,
8260 unsigned endpoint,
8261 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262{
8263 int ret = 0;
8264 unsigned char keyblk[256];
8265 unsigned char *key1;
8266 unsigned char *key2;
8267 unsigned char *mac_enc;
8268 unsigned char *mac_dec;
8269 size_t mac_key_len = 0;
8270 size_t iv_copy_len;
8271 size_t keylen;
8272 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008273 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008274#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008275 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008276 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008277#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008278
8279#if defined(MBEDTLS_USE_PSA_CRYPTO)
8280 psa_key_type_t key_type;
8281 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8282 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008283 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284 size_t key_bits;
8285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8286#endif
8287
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288 /*
8289 * Some data just needs copying into the structure
8290 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008291#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008292 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008293#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008294 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008295
8296#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008298#endif
8299
8300#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008302 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8303 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008305 }
8306#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8307
8308 /*
8309 * Get various info structures
8310 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8312 if (ciphersuite_info == NULL) {
8313 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8314 ciphersuite));
8315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008316 }
8317
Neil Armstrongab555e02022-04-04 11:07:59 +02008318 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008319#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008321#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008323
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008325 transform->taglen =
8326 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008328
8329#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008330 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 transform->taglen,
8332 &alg,
8333 &key_type,
8334 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008335 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008337 goto end;
8338 }
8339#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008340 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 if (cipher_info == NULL) {
8342 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8343 ciphersuite_info->cipher));
8344 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008346#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347
Neil Armstronge4512952022-03-08 09:08:22 +01008348#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008349 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008351 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 (unsigned) ciphersuite_info->mac));
8353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008354 }
8355#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008356 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 if (md_info == NULL) {
8358 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8359 (unsigned) ciphersuite_info->mac));
8360 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008361 }
Neil Armstronge4512952022-03-08 09:08:22 +01008362#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363
8364#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8365 /* Copy own and peer's CID if the use of the CID
8366 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8368 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008369
8370 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8372 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8373 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374
8375 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8377 ssl->handshake->peer_cid_len);
8378 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8379 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008380 }
8381#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8382
8383 /*
8384 * Compute key block using the PRF
8385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8387 if (ret != 0) {
8388 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8389 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390 }
8391
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8393 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8394 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8395 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8396 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008397
8398 /*
8399 * Determine the appropriate key, IV and MAC length.
8400 */
8401
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008402#if defined(MBEDTLS_USE_PSA_CRYPTO)
8403 keylen = PSA_BITS_TO_BYTES(key_bits);
8404#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008406#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407
Valerio Settie5707042023-10-11 11:54:42 +02008408#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008410 size_t explicit_ivlen;
8411
8412 transform->maclen = 0;
8413 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414
8415 /* All modes haves 96-bit IVs, but the length of the static parts vary
8416 * with mode and version:
8417 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8418 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8419 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8420 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8421 * sequence number).
8422 */
8423 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008424
8425 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008426#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008427 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008428#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8430 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008431#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008436 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438
8439 /* Minimum length of encrypted record */
8440 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8441 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 } else
Valerio Settie5707042023-10-11 11:54:42 +02008443#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008444#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008446 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008448#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008450#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008451 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008452#endif /* MBEDTLS_USE_PSA_CRYPTO */
8453
8454#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008455 /* Get MAC length */
8456 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8457#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8460 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8461 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462 goto end;
8463 }
8464
8465 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008467#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008468 transform->maclen = mac_key_len;
8469
8470 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008471#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008473#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008474 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008475#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008476
8477 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008479 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 /*
8482 * GenericBlockCipher:
8483 * 1. if EtM is in use: one block plus MAC
8484 * otherwise: * first multiple of blocklen greater than maclen
8485 * 2. IV
8486 */
8487#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008489 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 + block_size;
8491 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008492#endif
8493 {
8494 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 + block_size
8496 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008497 }
8498
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008500 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 } else {
8502 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008503 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8504 goto end;
8505 }
8506 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008508#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8509 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8511 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008512 }
8513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8515 (unsigned) keylen,
8516 (unsigned) transform->minlen,
8517 (unsigned) transform->ivlen,
8518 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008519
8520 /*
8521 * Finally setup the cipher contexts, IVs and MAC secrets.
8522 */
8523#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008525 key1 = keyblk + mac_key_len * 2;
8526 key2 = keyblk + mac_key_len * 2 + keylen;
8527
8528 mac_enc = keyblk;
8529 mac_dec = keyblk + mac_key_len;
8530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 iv_copy_len = (transform->fixed_ivlen) ?
8532 transform->fixed_ivlen : transform->ivlen;
8533 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8534 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8535 iv_copy_len);
8536 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537#endif /* MBEDTLS_SSL_CLI_C */
8538#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008540 key1 = keyblk + mac_key_len * 2 + keylen;
8541 key2 = keyblk + mac_key_len * 2;
8542
8543 mac_enc = keyblk + mac_key_len;
8544 mac_dec = keyblk;
8545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 iv_copy_len = (transform->fixed_ivlen) ?
8547 transform->fixed_ivlen : transform->ivlen;
8548 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8549 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8550 iv_copy_len);
8551 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552#endif /* MBEDTLS_SSL_SRV_C */
8553 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008555 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8556 goto end;
8557 }
8558
Paul Elliott4fb19552023-10-18 12:15:30 +01008559 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 ssl->f_export_keys(ssl->p_export_keys,
8561 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8562 master, 48,
8563 randbytes + 32,
8564 randbytes,
8565 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008566 }
8567
8568#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008569 transform->psa_alg = alg;
8570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8572 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8573 psa_set_key_algorithm(&attributes, alg);
8574 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008575
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if ((status = psa_import_key(&attributes,
8577 key1,
8578 PSA_BITS_TO_BYTES(key_bits),
8579 &transform->psa_key_enc)) != PSA_SUCCESS) {
8580 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008581 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583 goto end;
8584 }
8585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 if ((status = psa_import_key(&attributes,
8589 key2,
8590 PSA_BITS_TO_BYTES(key_bits),
8591 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008592 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008594 goto end;
8595 }
8596 }
8597#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8599 cipher_info)) != 0) {
8600 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008601 goto end;
8602 }
8603
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8605 cipher_info)) != 0) {
8606 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008607 goto end;
8608 }
8609
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8611 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8612 MBEDTLS_ENCRYPT)) != 0) {
8613 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008614 goto end;
8615 }
8616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8618 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8619 MBEDTLS_DECRYPT)) != 0) {
8620 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008621 goto end;
8622 }
8623
8624#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8626 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8627 MBEDTLS_PADDING_NONE)) != 0) {
8628 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008629 goto end;
8630 }
8631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8633 MBEDTLS_PADDING_NONE)) != 0) {
8634 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008635 goto end;
8636 }
8637 }
8638#endif /* MBEDTLS_CIPHER_MODE_CBC */
8639#endif /* MBEDTLS_USE_PSA_CRYPTO */
8640
Neil Armstrong29c0c042022-03-17 17:47:28 +01008641#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8642 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8643 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008645#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8649 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8650 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008651
Gilles Peskine449bd832023-01-11 14:50:10 +01008652 if ((status = psa_import_key(&attributes,
8653 mac_enc, mac_key_len,
8654 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008655 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008657 goto end;
8658 }
8659
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8661 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008662#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008663 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008664#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008666 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008667 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8668 PSA_KEY_USAGE_VERIFY_HASH);
8669 } else {
8670 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8671 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 if ((status = psa_import_key(&attributes,
8674 mac_dec, mac_key_len,
8675 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008676 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008678 goto end;
8679 }
8680#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8682 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008683 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 }
8685 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8686 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008687 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008689#endif /* MBEDTLS_USE_PSA_CRYPTO */
8690 }
8691#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8692
8693 ((void) mac_dec);
8694 ((void) mac_enc);
8695
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008696end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8698 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008699}
8700
Valerio Settia08b1a42022-11-17 15:10:02 +01008701#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8702 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008703int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 psa_pake_operation_t *pake_ctx,
8705 const unsigned char *buf,
8706 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008707{
8708 psa_status_t status;
8709 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008710 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008711 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8712 * At round two perform a single cycle
8713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008715
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 for (; remaining_steps > 0; remaining_steps--) {
8717 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008718 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008720 /* Length is stored at the first byte */
8721 size_t length = buf[input_offset];
8722 input_offset += 1;
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008725 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8726 }
8727
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 status = psa_pake_input(pake_ctx, step,
8729 buf + input_offset, length);
8730 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008731 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008732 }
8733
8734 input_offset += length;
8735 }
8736 }
8737
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008739 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008743}
8744
Valerio Setti6b3dab02022-11-17 17:14:54 +01008745int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 psa_pake_operation_t *pake_ctx,
8747 unsigned char *buf,
8748 size_t len, size_t *olen,
8749 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008750{
8751 psa_status_t status;
8752 size_t output_offset = 0;
8753 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008754 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008755 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8756 * At round two perform a single cycle
8757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008759
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 for (; remaining_steps > 0; remaining_steps--) {
8761 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8762 step <= PSA_PAKE_STEP_ZK_PROOF;
8763 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008764 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008765 * For each step, prepend 1 byte with the length of the data as
8766 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 status = psa_pake_output(pake_ctx, step,
8769 buf + output_offset + 1,
8770 len - output_offset - 1,
8771 &output_len);
8772 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008773 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008774 }
8775
Valerio Setti99d88c12022-11-22 16:03:43 +01008776 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008777
8778 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008779 }
8780 }
8781
8782 *olen = output_offset;
8783
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008785}
Valerio Settia08b1a42022-11-17 15:10:02 +01008786#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8787
Jerry Yuee40f9d2022-02-17 14:55:16 +08008788#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008789int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8790 unsigned char *hash, size_t *hashlen,
8791 unsigned char *data, size_t data_len,
8792 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008793{
8794 psa_status_t status;
8795 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008796 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008797
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if ((status = psa_hash_setup(&hash_operation,
8801 hash_alg)) != PSA_SUCCESS) {
8802 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803 goto exit;
8804 }
8805
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8807 64)) != PSA_SUCCESS) {
8808 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008809 goto exit;
8810 }
8811
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 if ((status = psa_hash_update(&hash_operation,
8813 data, data_len)) != PSA_SUCCESS) {
8814 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008815 goto exit;
8816 }
8817
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8819 hashlen)) != PSA_SUCCESS) {
8820 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8821 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008822 }
8823
8824exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 if (status != PSA_SUCCESS) {
8826 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8827 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8828 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008829 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008831 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8832 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008836 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838 }
8839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008841}
8842
8843#else
8844
Gilles Peskine449bd832023-01-11 14:50:10 +01008845int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8846 unsigned char *hash, size_t *hashlen,
8847 unsigned char *data, size_t data_len,
8848 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849{
8850 int ret = 0;
8851 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8853 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008854
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008856
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008858
8859 /*
8860 * digitally-signed struct {
8861 * opaque client_random[32];
8862 * opaque server_random[32];
8863 * ServerDHParams params;
8864 * };
8865 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008866 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8867 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008868 goto exit;
8869 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8871 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008872 goto exit;
8873 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8875 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008876 goto exit;
8877 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8879 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008880 goto exit;
8881 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8883 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008884 goto exit;
8885 }
8886
8887exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008889
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 if (ret != 0) {
8891 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8892 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8893 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008894
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008896}
8897#endif /* MBEDTLS_USE_PSA_CRYPTO */
8898
Jerry Yud9d91da2022-02-17 14:57:06 +08008899#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8900
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008901/* Find the preferred hash for a given signature algorithm. */
8902unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 mbedtls_ssl_context *ssl,
8904 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008905{
Gabor Mezei078e8032022-04-27 21:17:56 +02008906 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008907 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008908
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8910 return MBEDTLS_SSL_HASH_NONE;
8911 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008914 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008915 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8916 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008917 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8919 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008920
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008921 mbedtls_md_type_t md_alg =
8922 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8923 if (md_alg == MBEDTLS_MD_NONE) {
8924 continue;
8925 }
8926
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008930 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008931 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008932
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8934 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8935 PSA_ALG_ECDSA(psa_hash_alg),
8936 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008937 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008939
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8941 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8942 PSA_ALG_RSA_PKCS1V15_SIGN(
8943 psa_hash_alg),
8944 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008945 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008947 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008948#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008949
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008951 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008952 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008953
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008955}
8956
8957#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8958
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008959/* Serialization of TLS 1.2 sessions:
8960 *
8961 * struct {
Ronald Crona93e25e2024-02-09 10:01:30 +01008962 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8963 * uint32 ticket_lifetime;
8964 * } ClientOnlyData;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008965 *
Ronald Crona93e25e2024-02-09 10:01:30 +01008966 * struct {
8967 * uint64 start_time;
8968 * uint8 session_id_len; // at most 32
8969 * opaque session_id[32];
8970 * opaque master[48]; // fixed length in the standard
8971 * uint32 verify_result;
8972 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8973 * select (endpoint) {
8974 * case client: ClientOnlyData;
8975 * case server: uint64 ticket_creation_time;
8976 * };
8977 * uint8 mfl_code; // up to 255 according to standard
8978 * uint8 encrypt_then_mac; // 0 or 1
8979 * } serialized_session_tls12;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008981static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8982 unsigned char *buf,
8983 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984{
8985 unsigned char *p = buf;
8986 size_t used = 0;
8987
8988#if defined(MBEDTLS_HAVE_TIME)
8989 uint64_t start;
8990#endif
8991#if defined(MBEDTLS_X509_CRT_PARSE_C)
8992#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8993 size_t cert_len;
8994#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8995#endif /* MBEDTLS_X509_CRT_PARSE_C */
8996
8997 /*
8998 * Time
8999 */
9000#if defined(MBEDTLS_HAVE_TIME)
9001 used += 8;
9002
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009004 start = (uint64_t) session->start;
9005
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007 p += 8;
9008 }
9009#endif /* MBEDTLS_HAVE_TIME */
9010
9011 /*
9012 * Basic mandatory fields
9013 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01009014 used += 1 /* id_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 + sizeof(session->id)
9016 + sizeof(session->master)
9017 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 *p++ = MBEDTLS_BYTE_0(session->id_len);
9021 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022 p += 32;
9023
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009025 p += 48;
9026
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009028 p += 4;
9029 }
9030
9031 /*
9032 * Peer's end-entity certificate
9033 */
9034#if defined(MBEDTLS_X509_CRT_PARSE_C)
9035#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009037 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009039 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041
9042 used += 3 + cert_len;
9043
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 if (used <= buf_len) {
9045 *p++ = MBEDTLS_BYTE_2(cert_len);
9046 *p++ = MBEDTLS_BYTE_1(cert_len);
9047 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048
Gilles Peskine449bd832023-01-11 14:50:10 +01009049 if (session->peer_cert != NULL) {
9050 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009051 p += cert_len;
9052 }
9053 }
9054#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009055 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009056 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009058 *p++ = (unsigned char) session->peer_cert_digest_type;
9059 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 memcpy(p, session->peer_cert_digest,
9061 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009062 p += session->peer_cert_digest_len;
9063 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009067 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9068 *p++ = 0;
9069 }
9070 }
9071#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9072#endif /* MBEDTLS_X509_CRT_PARSE_C */
9073
9074 /*
9075 * Session ticket if any, plus associated data
9076 */
Ronald Cronc57f86e2023-11-22 09:50:01 +01009077#if defined(MBEDTLS_SSL_SESSION_TICKETS)
9078#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cronfeb577a2023-11-23 12:34:43 +01009079 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
9080 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081
Ronald Cronfeb577a2023-11-23 12:34:43 +01009082 if (used <= buf_len) {
9083 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9084 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9085 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086
Ronald Cronfeb577a2023-11-23 12:34:43 +01009087 if (session->ticket != NULL) {
9088 memcpy(p, session->ticket, session->ticket_len);
9089 p += session->ticket_len;
9090 }
9091
9092 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
9093 p += 4;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095 }
Ronald Cronc57f86e2023-11-22 09:50:01 +01009096#endif /* MBEDTLS_SSL_CLI_C */
9097#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
9098 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
9099 used += 8;
9100
9101 if (used <= buf_len) {
9102 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
9103 p += 8;
9104 }
9105 }
9106#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
9107#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009108
9109 /*
9110 * Misc extension-related info
9111 */
9112#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9113 used += 1;
9114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009116 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009118#endif
9119
9120#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9121 used += 1;
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if (used <= buf_len) {
9124 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9125 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009126#endif
9127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129}
9130
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009132static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9133 const unsigned char *buf,
9134 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135{
9136#if defined(MBEDTLS_HAVE_TIME)
9137 uint64_t start;
9138#endif
9139#if defined(MBEDTLS_X509_CRT_PARSE_C)
9140#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9141 size_t cert_len;
9142#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9143#endif /* MBEDTLS_X509_CRT_PARSE_C */
9144
9145 const unsigned char *p = buf;
9146 const unsigned char * const end = buf + len;
9147
9148 /*
9149 * Time
9150 */
9151#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009152 if (8 > (size_t) (end - p)) {
9153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9154 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009155
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009156 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009157 p += 8;
9158
9159 session->start = (time_t) start;
9160#endif /* MBEDTLS_HAVE_TIME */
9161
9162 /*
9163 * Basic mandatory fields
9164 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01009165 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9167 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009169 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171 p += 32;
9172
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174 p += 48;
9175
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009176 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009177 p += 4;
9178
9179 /* Immediately clear invalid pointer values that have been read, in case
9180 * we exit early before we replaced them with valid ones. */
9181#if defined(MBEDTLS_X509_CRT_PARSE_C)
9182#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9183 session->peer_cert = NULL;
9184#else
9185 session->peer_cert_digest = NULL;
9186#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9187#endif /* MBEDTLS_X509_CRT_PARSE_C */
9188#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9189 session->ticket = NULL;
9190#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9191
9192 /*
9193 * Peer certificate
9194 */
9195#if defined(MBEDTLS_X509_CRT_PARSE_C)
9196#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9197 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if (3 > (size_t) (end - p)) {
9199 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9200 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009202 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009203 p += 3;
9204
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9207
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if (cert_len > (size_t) (end - p)) {
9209 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9210 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009211
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 if (session->peer_cert == NULL) {
9215 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9216 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009217
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9221 p, cert_len)) != 0) {
9222 mbedtls_x509_crt_free(session->peer_cert);
9223 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009226 }
9227
9228 p += cert_len;
9229 }
9230#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9231 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 if (2 > (size_t) (end - p)) {
9233 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9234 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009235
9236 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9237 session->peer_cert_digest_len = (size_t) *p++;
9238
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009240 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9242 if (md_info == NULL) {
9243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9244 }
9245 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9246 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9247 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9250 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9251 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009252
9253 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 mbedtls_calloc(1, session->peer_cert_digest_len);
9255 if (session->peer_cert_digest == 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->peer_cert_digest, p,
9260 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009261 p += session->peer_cert_digest_len;
9262 }
9263#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9264#endif /* MBEDTLS_X509_CRT_PARSE_C */
9265
9266 /*
9267 * Session ticket and associated data
9268 */
Ronald Cronc57f86e2023-11-22 09:50:01 +01009269#if defined(MBEDTLS_SSL_SESSION_TICKETS)
9270#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cronfeb577a2023-11-23 12:34:43 +01009271 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
9272 if (3 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009273 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9274 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009275
Ronald Cronfeb577a2023-11-23 12:34:43 +01009276 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
9277 p += 3;
9278
9279 if (session->ticket_len != 0) {
9280 if (session->ticket_len > (size_t) (end - p)) {
9281 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9282 }
9283
9284 session->ticket = mbedtls_calloc(1, session->ticket_len);
9285 if (session->ticket == NULL) {
9286 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9287 }
9288
9289 memcpy(session->ticket, p, session->ticket_len);
9290 p += session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009291 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009292
Ronald Cronfeb577a2023-11-23 12:34:43 +01009293 if (4 > (size_t) (end - p)) {
9294 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9295 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009296
Ronald Cronfeb577a2023-11-23 12:34:43 +01009297 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
9298 p += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 }
Ronald Cronc57f86e2023-11-22 09:50:01 +01009300#endif /* MBEDTLS_SSL_CLI_C */
9301#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
9302 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
9303 if (8 > (size_t) (end - p)) {
9304 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9305 }
9306 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
9307 p += 8;
9308 }
9309#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
9310#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009311
9312 /*
9313 * Misc extension-related info
9314 */
9315#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009316 if (1 > (size_t) (end - p)) {
9317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9318 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009319
9320 session->mfl_code = *p++;
9321#endif
9322
9323#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if (1 > (size_t) (end - p)) {
9325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9326 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009327
9328 session->encrypt_then_mac = *p++;
9329#endif
9330
9331 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if (p != end) {
9333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9334 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009335
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009337}
Jerry Yudc7bd172022-02-17 13:44:15 +08009338#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9339
XiaokangQian75d40ef2022-04-20 11:05:24 +00009340int mbedtls_ssl_validate_ciphersuite(
9341 const mbedtls_ssl_context *ssl,
9342 const mbedtls_ssl_ciphersuite_t *suite_info,
9343 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009345{
9346 (void) ssl;
9347
Gilles Peskine449bd832023-01-11 14:50:10 +01009348 if (suite_info == NULL) {
9349 return -1;
9350 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009351
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 if ((suite_info->min_tls_version > max_tls_version) ||
9353 (suite_info->max_tls_version < min_tls_version)) {
9354 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009355 }
9356
XiaokangQian060d8672022-04-21 09:24:56 +00009357#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009358#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009359#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9361 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009362#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009363 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9364 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009365#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009366 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009368 }
9369#endif
9370
9371 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9372#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9374 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9375 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009376 }
9377#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9378#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009381}
9382
Ronald Crone68ab4f2022-10-05 12:46:29 +02009383#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009384/*
9385 * Function for writing a signature algorithm extension.
9386 *
9387 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9388 * value (TLS 1.3 RFC8446):
9389 * enum {
9390 * ....
9391 * ecdsa_secp256r1_sha256( 0x0403 ),
9392 * ecdsa_secp384r1_sha384( 0x0503 ),
9393 * ecdsa_secp521r1_sha512( 0x0603 ),
9394 * ....
9395 * } SignatureScheme;
9396 *
9397 * struct {
9398 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9399 * } SignatureSchemeList;
9400 *
9401 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9402 * value (TLS 1.2 RFC5246):
9403 * enum {
9404 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9405 * sha512(6), (255)
9406 * } HashAlgorithm;
9407 *
9408 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9409 * SignatureAlgorithm;
9410 *
9411 * struct {
9412 * HashAlgorithm hash;
9413 * SignatureAlgorithm signature;
9414 * } SignatureAndHashAlgorithm;
9415 *
9416 * SignatureAndHashAlgorithm
9417 * supported_signature_algorithms<2..2^16-2>;
9418 *
9419 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9420 * generalization of the TLS 1.2 signature algorithm extension.
9421 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9422 * `SignatureScheme` field of TLS 1.3
9423 *
9424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009425int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9426 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009427{
9428 unsigned char *p = buf;
9429 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9430 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9431
9432 *out_len = 0;
9433
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009435
9436 /* Check if we have space for header and length field:
9437 * - extension_type (2 bytes)
9438 * - extension_data_length (2 bytes)
9439 * - supported_signature_algorithms_length (2 bytes)
9440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009442 p += 6;
9443
9444 /*
9445 * Write supported_signature_algorithms
9446 */
9447 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9449 if (sig_alg == NULL) {
9450 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9451 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009452
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9454 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9455 *sig_alg,
9456 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9457 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009458 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 }
9460 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9461 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009462 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9464 *sig_alg,
9465 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009466 }
9467
9468 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009469 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 if (supported_sig_alg_len == 0) {
9471 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009473 }
9474
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9476 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9477 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009478
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009479 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009480
9481#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009482 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009483#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009486}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009487#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009488
XiaokangQian40a35232022-05-07 09:02:40 +00009489#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009490/*
9491 * mbedtls_ssl_parse_server_name_ext
9492 *
9493 * Structure of server_name extension:
9494 *
9495 * enum {
9496 * host_name(0), (255)
9497 * } NameType;
9498 * opaque HostName<1..2^16-1>;
9499 *
9500 * struct {
9501 * NameType name_type;
9502 * select (name_type) {
9503 * case host_name: HostName;
9504 * } name;
9505 * } ServerName;
9506 * struct {
9507 * ServerName server_name_list<1..2^16-1>
9508 * } ServerNameList;
9509 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009511int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9512 const unsigned char *buf,
9513 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009514{
9515 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9516 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009517 size_t server_name_list_len, hostname_len;
9518 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009519
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009521
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9523 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009524 p += 2;
9525
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009527 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 while (p < server_name_list_end) {
9529 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9530 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9532 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009533
Gilles Peskine449bd832023-01-11 14:50:10 +01009534 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009535 /* sni_name is intended to be used only during the parsing of the
9536 * ClientHello message (it is reset to NULL before the end of
9537 * the message parsing). Thus it is ok to just point to the
9538 * reception buffer and not make a copy of it.
9539 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009540 ssl->handshake->sni_name = p + 3;
9541 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 if (ssl->conf->f_sni == NULL) {
9543 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009544 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9546 ssl, p + 3, hostname_len);
9547 if (ret != 0) {
9548 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9549 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9550 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9551 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9552 }
9553 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009554 }
9555
9556 p += hostname_len + 3;
9557 }
9558
Gilles Peskine449bd832023-01-11 14:50:10 +01009559 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009560}
9561#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9562
XiaokangQianacb39922022-06-17 10:18:48 +00009563#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009565int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9566 const unsigned char *buf,
9567 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009568{
9569 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009570 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 const unsigned char *protocol_name_list;
9572 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009573 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009574
9575 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 if (ssl->conf->alpn_list == NULL) {
9577 return 0;
9578 }
XiaokangQianacb39922022-06-17 10:18:48 +00009579
9580 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009581 * RFC7301, section 3.1
9582 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009583 *
XiaokangQianc7403452022-06-23 03:24:12 +00009584 * struct {
9585 * ProtocolName protocol_name_list<2..2^16-1>
9586 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009587 */
9588
XiaokangQianc7403452022-06-23 03:24:12 +00009589 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009590 * protocol_name_list_len 2 bytes
9591 * protocol_name_len 1 bytes
9592 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009595
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009597 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009599 protocol_name_list = p;
9600 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009601
9602 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009604 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9606 protocol_name_len);
9607 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009608 MBEDTLS_SSL_PEND_FATAL_ALERT(
9609 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9611 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009612 }
9613
9614 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009615 }
9616
9617 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9619 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009620 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009622 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 if (protocol_name_len == alpn_len &&
9624 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009625 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009627 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009628
9629 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009630 }
9631 }
9632
XiaokangQian95d5f542022-06-24 02:29:26 +00009633 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009634 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9636 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9637 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009638}
9639
Gilles Peskine449bd832023-01-11 14:50:10 +01009640int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9641 unsigned char *buf,
9642 unsigned char *end,
9643 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009644{
9645 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009646 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009647 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009648
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 if (ssl->alpn_chosen == NULL) {
9650 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009651 }
9652
Gilles Peskine449bd832023-01-11 14:50:10 +01009653 protocol_name_len = strlen(ssl->alpn_chosen);
9654 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009655
Gilles Peskine449bd832023-01-11 14:50:10 +01009656 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009657 /*
9658 * 0 . 1 ext identifier
9659 * 2 . 3 ext length
9660 * 4 . 5 protocol list length
9661 * 6 . 6 protocol name length
9662 * 7 . 7+n protocol name
9663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009664 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009665
XiaokangQian95d5f542022-06-24 02:29:26 +00009666 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009667
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9669 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009670 /* Note: the length of the chosen protocol has been checked to be less
9671 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009674
Gilles Peskine449bd832023-01-11 14:50:10 +01009675 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009676
9677#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009679#endif
9680
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009682}
9683#endif /* MBEDTLS_SSL_ALPN */
9684
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009685#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009686 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009687 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009688 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009689int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9690 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009691{
9692 /* Initialize to suppress unnecessary compiler warning */
9693 size_t hostname_len = 0;
9694
9695 /* Check if new hostname is valid before
9696 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 if (hostname != NULL) {
9698 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009699
Gilles Peskine449bd832023-01-11 14:50:10 +01009700 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9702 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009703 }
9704
9705 /* Now it's clear that we will overwrite the old hostname,
9706 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009707 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009708 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009709 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009710 }
9711
9712 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009713 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009714 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009715 } else {
9716 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9717 if (session->hostname == NULL) {
9718 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9719 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009720
Gilles Peskine449bd832023-01-11 14:50:10 +01009721 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009722 }
9723
Gilles Peskine449bd832023-01-11 14:50:10 +01009724 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009725}
Xiaokang Qian03409292022-10-12 02:49:52 +00009726#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9727 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009728 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009729 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009731#endif /* MBEDTLS_SSL_TLS_C */