blob: ee72179997d4aee11b89441ecfc8ebf147f5895a [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
Ronald Cron26a98112024-02-23 08:23:40 +01001108 ssl->early_data_count = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001109#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001110
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001111 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_session_init(ssl->session_negotiate);
1113 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001114
Jerry Yu2e199812022-12-01 18:57:19 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001117#endif
1118
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001119 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001120 ret = mbedtls_ssl_reset_checksum(ssl);
1121 if (ret != 0) {
1122 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1123 return ret;
1124 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001125
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1127 defined(MBEDTLS_SSL_SRV_C) && \
1128 defined(MBEDTLS_SSL_SESSION_TICKETS)
1129 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001131#endif
1132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001138 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001144 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001145#endif
1146
Brett Warrene0edc842021-08-17 09:53:13 +01001147/*
1148 * curve_list is translated to IANA TLS group identifiers here because
1149 * mbedtls_ssl_conf_curves returns void and so can't return
1150 * any error codes.
1151 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001152#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001153#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1154 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001156 size_t length;
1157 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1158
Thomas Daubney850a0792023-05-22 12:05:03 +01001159 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 }
Brett Warrene0edc842021-08-17 09:53:13 +01001161
1162 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1164 if (group_list == NULL) {
1165 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1166 }
Brett Warrene0edc842021-08-17 09:53:13 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001169 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 curve_list[i]);
1171 if (tls_id == 0) {
1172 mbedtls_free(group_list);
1173 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001174 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001175 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001176 }
1177
1178 group_list[length] = 0;
1179
1180 ssl->handshake->group_list = group_list;
1181 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001183 ssl->handshake->group_list = ssl->conf->group_list;
1184 ssl->handshake->group_list_heap_allocated = 0;
1185 }
1186#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001187#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001188
Ronald Crone68ab4f2022-10-05 12:46:29 +02001189#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001190#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001192 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1193 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1195 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 const int *md;
1197 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001198 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 uint16_t *p;
1200
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001201 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1202 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1203 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1206 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001209#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001212
Jerry Yub476a442022-01-21 18:14:45 +08001213#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001215#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219 }
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1226 sizeof(uint16_t));
1227 if (ssl->handshake->sig_algs == NULL) {
1228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 p = (uint16_t *) ssl->handshake->sig_algs;
1232 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1233 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1234 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001237#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
1241#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001244#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001246 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 ssl->handshake->sig_algs_heap_allocated = 0;
1252 }
Jerry Yucc539102022-06-27 16:27:35 +08001253#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001254#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001256}
1257
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001258#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001261static int ssl_cookie_write_dummy(void *ctx,
1262 unsigned char **p, unsigned char *end,
1263 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264{
1265 ((void) ctx);
1266 ((void) p);
1267 ((void) end);
1268 ((void) cli_id);
1269 ((void) cli_id_len);
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001272}
1273
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static int ssl_cookie_check_dummy(void *ctx,
1276 const unsigned char *cookie, size_t cookie_len,
1277 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278{
1279 ((void) ctx);
1280 ((void) cookie);
1281 ((void) cookie_len);
1282 ((void) cli_id);
1283 ((void) cli_id_len);
1284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001286}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001287#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289/*
1290 * Initialize an SSL context
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001293{
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295}
1296
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001299{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001300 const mbedtls_ssl_config *conf = ssl->conf;
1301
Ronald Cron6f135e12021-12-08 16:57:54 +01001302#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1304 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001307 }
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1310 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001311 }
1312#endif
1313
1314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1316 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1317 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001318 }
1319#endif
1320
Ronald Cron6f135e12021-12-08 16:57:54 +01001321#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1323 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1325 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1329 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001330 }
1331#endif
1332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1334 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001335}
1336
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001337MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001338static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1339{
1340 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 ret = ssl_conf_version_check(ssl);
1342 if (ret != 0) {
1343 return ret;
1344 }
Jerry Yu60835a82021-08-04 10:13:52 +08001345
Jerry Yudef7ae42022-10-30 14:13:19 +08001346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1347 /* RFC 8446 section 4.4.3
1348 *
1349 * If the verification fails, the receiver MUST terminate the handshake with
1350 * a "decrypt_error" alert.
1351 *
1352 * If the client is configured as TLS 1.3 only with optional verify, return
1353 * bad config.
1354 *
1355 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001356 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1359 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1360 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 1, ("Optional verify auth mode "
1364 "is not available for TLS 1.3 client"));
1365 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001366 }
1367#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1368
Jerry Yu60835a82021-08-04 10:13:52 +08001369 /* Space for further checks */
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001372}
1373
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001374/*
1375 * Setup an SSL context
1376 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1379 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001380{
Janos Follath865b3eb2019-12-16 11:46:15 +00001381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001382 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1383 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001384
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001385 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 if ((ret = ssl_conf_check(ssl)) != 0) {
1388 return ret;
1389 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001390 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001391
Paul Bakker62f2dee2012-09-28 07:31:51 +00001392 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001393 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001394 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001395
1396 /* Set to NULL in case of an error condition */
1397 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001398
Darryl Greenb33cc762019-11-28 14:29:44 +00001399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1400 ssl->in_buf_len = in_buf_len;
1401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1403 if (ssl->in_buf == NULL) {
1404 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001405 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001406 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001407 }
1408
Darryl Greenb33cc762019-11-28 14:29:44 +00001409#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1410 ssl->out_buf_len = out_buf_len;
1411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1413 if (ssl->out_buf == NULL) {
1414 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001415 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001416 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001417 }
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001420
Johan Pascalb62bb512015-12-03 21:56:45 +01001421#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001423#endif
1424
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001426 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001430
1431error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 mbedtls_free(ssl->in_buf);
1433 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001434
1435 ssl->conf = NULL;
1436
Darryl Greenb33cc762019-11-28 14:29:44 +00001437#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1438 ssl->in_buf_len = 0;
1439 ssl->out_buf_len = 0;
1440#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001441 ssl->in_buf = NULL;
1442 ssl->out_buf = NULL;
1443
1444 ssl->in_hdr = NULL;
1445 ssl->in_ctr = NULL;
1446 ssl->in_len = NULL;
1447 ssl->in_iv = NULL;
1448 ssl->in_msg = NULL;
1449
1450 ssl->out_hdr = NULL;
1451 ssl->out_ctr = NULL;
1452 ssl->out_len = NULL;
1453 ssl->out_iv = NULL;
1454 ssl->out_msg = NULL;
1455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001457}
1458
1459/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460 * Reset an initialized and used SSL context for re-use while retaining
1461 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 *
1463 * If partial is non-zero, keep data in the input buffer and client ID.
1464 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001466void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1467 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001468{
Darryl Greenb33cc762019-11-28 14:29:44 +00001469#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1470 size_t in_buf_len = ssl->in_buf_len;
1471 size_t out_buf_len = ssl->out_buf_len;
1472#else
1473 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1474 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1475#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001476
Hanno Beckerb0302c42021-08-03 09:39:42 +01001477#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1478 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001479#endif
1480
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001481 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001485
1486 /* Reset incoming message parsing */
1487 ssl->in_offt = NULL;
1488 ssl->nb_zero = 0;
1489 ssl->in_msgtype = 0;
1490 ssl->in_msglen = 0;
1491 ssl->in_hslen = 0;
1492 ssl->keep_current_message = 0;
1493 ssl->transform_in = NULL;
1494
1495#if defined(MBEDTLS_SSL_PROTO_DTLS)
1496 ssl->next_record_offset = 0;
1497 ssl->in_epoch = 0;
1498#endif
1499
1500 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001502 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001504 }
1505
Ronald Cronad8c17b2022-06-10 17:18:09 +02001506 ssl->send_alert = 0;
1507
Hanno Beckerb0302c42021-08-03 09:39:42 +01001508 /* Reset outgoing message writing */
1509 ssl->out_msgtype = 0;
1510 ssl->out_msglen = 0;
1511 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 memset(ssl->out_buf, 0, out_buf_len);
1513 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001514 ssl->transform_out = NULL;
1515
1516#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518#endif
1519
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (ssl->transform) {
1522 mbedtls_ssl_transform_free(ssl->transform);
1523 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 ssl->transform = NULL;
1525 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1527
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->transform_application);
1530 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->transform_application = NULL;
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001534#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1536 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001538#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1541 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_handshake = NULL;
1543 }
1544
XiaokangQian2b01dc32022-01-21 02:53:13 +00001545#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001546}
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549{
1550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1551
1552 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001555
1556 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#if defined(MBEDTLS_SSL_RENEGOTIATION)
1558 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
1561 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1563 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001566
Hanno Beckerb0302c42021-08-03 09:39:42 +01001567 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001568 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (ssl->session) {
1570 mbedtls_ssl_session_free(ssl->session);
1571 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001572 ssl->session = NULL;
1573 }
1574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001576 ssl->alpn_chosen = NULL;
1577#endif
1578
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001579#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001580 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001581#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 if (free_cli_id) {
1585 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001586 ssl->cli_id = NULL;
1587 ssl->cli_id_len = 0;
1588 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001589#endif
1590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if ((ret = ssl_handshake_init(ssl)) != 0) {
1592 return ret;
1593 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001596}
1597
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001598/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599 * Reset an initialized and used SSL context for re-use while retaining
1600 * all application-set variables, function pointers and data.
1601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603{
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605}
1606
1607/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001608 * SSL set accessors
1609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001613}
1614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618}
1619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001624}
1625#endif
1626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1635 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001636{
1637 ssl->disable_datagram_packing = !allow_packing;
1638}
1639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1641 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001642{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001643 conf->hs_timeout_min = min;
1644 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001645}
1646#endif
1647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001650 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001651}
1652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001654void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1655 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1656 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001657{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001658 conf->f_vrfy = f_vrfy;
1659 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001660}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1664 int (*f_rng)(void *, unsigned char *, size_t),
1665 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001667 conf->f_rng = f_rng;
1668 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1672 void (*f_dbg)(void *, int, const char *, int, const char *),
1673 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_dbg = f_dbg;
1676 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001677}
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1680 void *p_bio,
1681 mbedtls_ssl_send_t *f_send,
1682 mbedtls_ssl_recv_t *f_recv,
1683 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001684{
1685 ssl->p_bio = p_bio;
1686 ssl->f_send = f_send;
1687 ssl->f_recv = f_recv;
1688 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001689}
1690
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001693{
1694 ssl->mtu = mtu;
1695}
1696#endif
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001699{
1700 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701}
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1704 void *p_timer,
1705 mbedtls_ssl_set_timer_t *f_set_timer,
1706 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001707{
1708 ssl->p_timer = p_timer;
1709 ssl->f_set_timer = f_set_timer;
1710 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001711
1712 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001714}
1715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001717void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1718 void *p_cache,
1719 mbedtls_ssl_cache_get_t *f_get_cache,
1720 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001721{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001722 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001723 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001725}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Janos Follath865b3eb2019-12-16 11:46:15 +00001731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001734 session == NULL ||
1735 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001738 }
1739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (ssl->handshake->resume == 1) {
1741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1742 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001743
Jerry Yu21092062022-10-10 21:21:31 +08001744#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001746 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001750 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1752 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1753 session->ciphersuite));
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001755 }
Jerry Yu40afab62022-10-08 10:42:13 +08001756 }
Jerry Yu21092062022-10-10 21:21:31 +08001757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1760 session)) != 0) {
1761 return ret;
1762 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001763
Paul Bakker0a597072012-09-25 21:55:46 +00001764 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001767}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1771 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001772{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001773 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001774}
1775
Ronald Cron6f135e12021-12-08 16:57:54 +01001776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001777void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1778 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001779{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001780 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001782
1783#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001784void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1785 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001786{
1787 conf->early_data_enabled = early_data_enabled;
1788}
Jerry Yucc4e0072022-11-22 17:22:22 +08001789
1790#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001791void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001793{
Jerry Yu39da9852022-12-06 16:58:36 +08001794 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001795}
1796#endif /* MBEDTLS_SSL_SRV_C */
1797
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001798#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001799#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1803 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001804{
1805 conf->cert_profile = profile;
1806}
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001809{
1810 mbedtls_ssl_key_cert *cur = key_cert, *next;
1811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001813 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 cur = next;
1816 }
1817}
1818
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001819/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001820MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001821static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1822 mbedtls_x509_crt *cert,
1823 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001824{
niisato8ee24222018-06-25 19:05:48 +09001825 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001828 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 }
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1835 if (new_cert == NULL) {
1836 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1837 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001838
niisato8ee24222018-06-25 19:05:48 +09001839 new_cert->cert = cert;
1840 new_cert->key = key;
1841 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001842
Glenn Strauss36872db2022-01-22 05:06:31 -05001843 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001845 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 }
niisato8ee24222018-06-25 19:05:48 +09001851 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852 }
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001855}
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860{
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001862}
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001865 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001867{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 conf->ca_chain = ca_chain;
1869 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001870
1871#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1872 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1873 * cannot be used together. */
1874 conf->f_ca_cb = NULL;
1875 conf->p_ca_cb = NULL;
1876#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001877}
Hanno Becker5adaad92019-03-27 16:54:37 +00001878
1879#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001880void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1881 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1882 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001883{
1884 conf->f_ca_cb = f_ca_cb;
1885 conf->p_ca_cb = p_ca_cb;
1886
1887 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1888 * cannot be used together. */
1889 conf->ca_chain = NULL;
1890 conf->ca_crl = NULL;
1891}
1892#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001894
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1897 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001898{
1899 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001901}
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1904 mbedtls_x509_crt *own_cert,
1905 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001906{
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1908 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1912 mbedtls_x509_crt *ca_chain,
1913 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001914{
1915 ssl->handshake->sni_ca_chain = ca_chain;
1916 ssl->handshake->sni_ca_crl = ca_crl;
1917}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918
Glenn Strauss999ef702022-03-11 01:37:23 -05001919#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1921 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001922{
1923 ssl->handshake->dn_hints = crt;
1924}
1925#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1928 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001929{
1930 ssl->handshake->sni_authmode = authmode;
1931}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1933
Hanno Becker8927c832019-04-03 12:52:50 +01001934#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001935void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1936 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1937 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001938{
1939 ssl->f_vrfy = f_vrfy;
1940 ssl->p_vrfy = p_vrfy;
1941}
1942#endif
1943
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001944#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001945
Valerio Setti016f6822022-12-09 14:17:50 +01001946#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001947static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1948static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1949
Valerio Setti016f6822022-12-09 14:17:50 +01001950static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 mbedtls_ssl_context *ssl,
1952 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001953{
1954 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001955 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001956 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001957 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1961 psa_pake_cs_set_primitive(&cipher_suite,
1962 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1963 PSA_ECC_FAMILY_SECP_R1,
1964 256));
1965 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1968 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001969 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 user = jpake_server_id;
1974 user_len = sizeof(jpake_server_id);
1975 peer = jpake_client_id;
1976 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001978 user = jpake_client_id;
1979 user_len = sizeof(jpake_client_id);
1980 peer = jpake_server_id;
1981 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001983
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001984 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1985 if (status != PSA_SUCCESS) {
1986 return status;
1987 }
1988
1989 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001991 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Valerio Setti016f6822022-12-09 14:17:50 +01001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1995 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001996 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
Valerio Setti016f6822022-12-09 14:17:50 +01001998
1999 ssl->handshake->psa_pake_ctx_is_ok = 1;
2000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2005 const unsigned char *pw,
2006 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002007{
2008 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2009 psa_status_t status;
2010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (ssl->handshake == NULL || ssl->conf == NULL) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002013 }
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 /* Empty password is not valid */
2016 if ((pw == NULL) || (pw_len == 0)) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019
2020 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2021 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2022 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2023
2024 status = psa_import_key(&attributes, pw, pw_len,
2025 &ssl->handshake->psa_pake_password);
2026 if (status != PSA_SUCCESS) {
2027 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2028 }
2029
2030 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2031 ssl->handshake->psa_pake_password);
2032 if (status != PSA_SUCCESS) {
2033 psa_destroy_key(ssl->handshake->psa_pake_password);
2034 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2035 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2036 }
2037
2038 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002039}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2042 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044 psa_status_t status;
2045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake == NULL || ssl->conf == NULL) {
2047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002048 }
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 if (mbedtls_svc_key_id_is_null(pwd)) {
2051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2052 }
2053
2054 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2055 if (status != PSA_SUCCESS) {
2056 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2057 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2058 }
2059
2060 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002061}
2062#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2064 const unsigned char *pw,
2065 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066{
2067 mbedtls_ecjpake_role role;
2068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->handshake == NULL || ssl->conf == NULL) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Valerio Settic689ed82022-12-07 14:40:38 +01002073 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if ((pw == NULL) || (pw_len == 0)) {
2075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2076 }
Valerio Settic689ed82022-12-07 14:40:38 +01002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002079 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2085 role,
2086 MBEDTLS_MD_SHA256,
2087 MBEDTLS_ECP_DP_SECP256R1,
2088 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002089}
Valerio Setti02c25b52022-11-15 14:08:42 +01002090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002091#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092
Ronald Cron73fe8df2022-10-05 14:31:43 +02002093#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002094int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095{
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk_identity == NULL ||
2097 conf->psk_identity_len == 0) {
2098 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002099 }
2100
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2103 return 1;
2104 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002105#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (conf->psk != NULL && conf->psk_len != 0) {
2108 return 1;
2109 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112}
2113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115{
2116 /* Remove reference to existing PSK, if any. */
2117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002119 /* The maintenance of the PSK key slot is the
2120 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002121 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002125 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126 conf->psk = NULL;
2127 conf->psk_len = 0;
2128 }
2129
2130 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 if (conf->psk_identity != NULL) {
2132 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002133 conf->psk_identity = NULL;
2134 conf->psk_identity_len = 0;
2135 }
2136}
2137
Hanno Becker7390c712018-11-15 13:33:04 +00002138/* This function assumes that PSK identity in the SSL config is unset.
2139 * It checks that the provided identity is well-formed and attempts
2140 * to make a copy of it in the SSL config.
2141 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002143static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2144 unsigned char const *psk_identity,
2145 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002146{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002147 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002149 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 (psk_identity_len >> 16) != 0 ||
2151 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002153 }
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2156 if (conf->psk_identity == NULL) {
2157 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2158 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002159
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002160 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002164}
2165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2167 const unsigned char *psk, size_t psk_len,
2168 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002169{
Janos Follath865b3eb2019-12-16 11:46:15 +00002170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002171
2172 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2174 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2175 }
Hanno Becker7390c712018-11-15 13:33:04 +00002176
2177 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (psk == NULL) {
2179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2180 }
2181 if (psk_len == 0) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2189 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2190 }
Hanno Becker7390c712018-11-15 13:33:04 +00002191 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002193
2194 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2196 if (ret != 0) {
2197 ssl_conf_remove_psk(conf);
2198 }
Hanno Becker7390c712018-11-15 13:33:04 +00002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002201}
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002204{
2205#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002207 /* The maintenance of the external PSK key slot is the
2208 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (ssl->handshake->psk_opaque_is_internal) {
2210 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002211 ssl->handshake->psk_opaque_is_internal = 0;
2212 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002213 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002214 }
Neil Armstronge952a302022-05-03 10:22:14 +02002215#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002217 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002219 ssl->handshake->psk_len = 0;
2220 }
Neil Armstronge952a302022-05-03 10:22:14 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222}
2223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2225 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226{
Neil Armstrong501c9322022-05-03 09:35:09 +02002227#if defined(MBEDTLS_USE_PSA_CRYPTO)
2228 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002230 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002231 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002232#endif /* MBEDTLS_USE_PSA_CRYPTO */
2233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (psk == NULL || ssl->handshake == NULL) {
2235 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2236 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2240 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002243
Neil Armstrong501c9322022-05-03 09:35:09 +02002244#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2247 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2248 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2249 } else {
2250 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2251 }
2252 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002253 }
2254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Jerry Yu568ec252022-07-22 21:27:34 +08002256#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2258 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2259 psa_set_key_usage_flags(&key_attributes,
2260 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002261 }
2262#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 psa_set_key_algorithm(&key_attributes, alg);
2265 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2268 if (status != PSA_SUCCESS) {
2269 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2270 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
2272 /* Allow calling psa_destroy_key() on psk remove */
2273 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002275#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2277 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2278 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002279
2280 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002284#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002285}
2286
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002287#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002288int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2289 mbedtls_svc_key_id_t psk,
2290 const unsigned char *psk_identity,
2291 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002292{
Janos Follath865b3eb2019-12-16 11:46:15 +00002293 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002294
2295 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2297 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2298 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002299
Hanno Becker7390c712018-11-15 13:33:04 +00002300 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_svc_key_id_is_null(psk)) {
2302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2303 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002304 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002305
2306 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2308 psk_identity_len);
2309 if (ret != 0) {
2310 ssl_conf_remove_psk(conf);
2311 }
Hanno Becker7390c712018-11-15 13:33:04 +00002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002314}
2315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2317 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002318{
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if ((mbedtls_svc_key_id_is_null(psk)) ||
2320 (ssl->handshake == NULL)) {
2321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2322 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002325 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327}
2328#endif /* MBEDTLS_USE_PSA_CRYPTO */
2329
Jerry Yu8897c072022-08-12 13:56:53 +08002330#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002331void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2332 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2333 size_t),
2334 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002335{
2336 conf->f_psk = f_psk;
2337 conf->p_psk = p_psk;
2338}
Jerry Yu8897c072022-08-12 13:56:53 +08002339#endif /* MBEDTLS_SSL_SRV_C */
2340
Ronald Cron73fe8df2022-10-05 14:31:43 +02002341#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002342
2343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002344static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002346{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 if (alg == PSA_ALG_CBC_NO_PADDING) {
2349 return MBEDTLS_SSL_MODE_CBC;
2350 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (PSA_ALG_IS_AEAD(alg)) {
2353 return MBEDTLS_SSL_MODE_AEAD;
2354 }
2355 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002356}
2357
2358#else /* MBEDTLS_USE_PSA_CRYPTO */
2359
2360static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002362{
2363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (mode == MBEDTLS_MODE_CBC) {
2365 return MBEDTLS_SSL_MODE_CBC;
2366 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002367#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2368
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369#if defined(MBEDTLS_GCM_C) || \
2370 defined(MBEDTLS_CCM_C) || \
2371 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 mode == MBEDTLS_MODE_CHACHAPOLY) {
2375 return MBEDTLS_SSL_MODE_AEAD;
2376 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380}
Gilles Peskine301711e2022-04-26 16:57:05 +02002381#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskinee108d982022-04-26 16:50:40 +02002383static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2384 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002386{
2387#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2389 base_mode == MBEDTLS_SSL_MODE_CBC) {
2390 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002391 }
2392#else
2393 (void) encrypt_then_mac;
2394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002396}
2397
Neil Armstrongab555e02022-04-04 11:07:59 +02002398mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002400{
Gilles Peskinee108d982022-04-26 16:50:40 +02002401 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002406#endif
2407 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408
Gilles Peskinee108d982022-04-26 16:50:40 +02002409 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002410#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 encrypt_then_mac = transform->encrypt_then_mac;
2412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002414}
2415
Neil Armstrongab555e02022-04-04 11:07:59 +02002416mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002417#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002419#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002421{
Gilles Peskinee108d982022-04-26 16:50:40 +02002422 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2423
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424#if defined(MBEDTLS_USE_PSA_CRYPTO)
2425 psa_status_t status;
2426 psa_algorithm_t alg;
2427 psa_key_type_t type;
2428 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002429 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2430 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (status == PSA_SUCCESS) {
2432 base_mode = mbedtls_ssl_get_base_mode(alg);
2433 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002434#else
2435 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002436 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 base_mode =
2439 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002441 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002442#endif /* MBEDTLS_USE_PSA_CRYPTO */
2443
Gilles Peskinee108d982022-04-26 16:50:40 +02002444#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2445 int encrypt_then_mac = 0;
2446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002448}
2449
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002450#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002451
2452#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002453/* Serialization of TLS 1.3 sessions:
2454 *
2455 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002456 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002457 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002459 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002460 * } ClientOnlyData;
2461 *
2462 * struct {
Jerry Yu438ddd82022-07-07 06:55:50 +00002463 * uint32 ticket_age_add;
2464 * uint8 ticket_flags;
2465 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002466 * uint32 max_early_data_size;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002467 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002468 * select ( endpoint ) {
2469 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002470 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002471 * };
2472 * } serialized_session_tls13;
2473 *
2474 */
2475#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002477static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2478 unsigned char *buf,
2479 size_t buf_len,
2480 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002481{
2482 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002483#if defined(MBEDTLS_SSL_CLI_C) && \
2484 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 size_t hostname_len = (session->hostname == NULL) ?
2486 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002487#endif
Ronald Cron40a4ab02024-01-15 10:21:30 +01002488 size_t needed = 4 /* ticket_age_add */
2489 + 1 /* ticket_flags */
2490 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002491 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2494 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2495 }
Jerry Yu34191072022-08-18 10:32:09 +08002496 needed += session->resumption_key_len; /* resumption_key */
2497
Jerry Yu02e3a072022-12-12 15:13:20 +08002498#if defined(MBEDTLS_SSL_EARLY_DATA)
2499 needed += 4; /* max_early_data_size */
2500#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002501#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002502 needed += 2; /* record_size_limit */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002503#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002504
Jerry Yu438ddd82022-07-07 06:55:50 +00002505#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002506 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002507#endif
2508
2509#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002511#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002512 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002514#endif
2515
Jerry Yu438ddd82022-07-07 06:55:50 +00002516 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002517 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002518
2519 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 if (session->ticket_len > SIZE_MAX - needed) {
2521 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2522 }
Jerry Yu34191072022-08-18 10:32:09 +08002523
Jerry Yue28d9742022-08-18 15:44:03 +08002524 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002525 }
2526#endif /* MBEDTLS_SSL_CLI_C */
2527
Jerry Yue36fdd62022-08-17 21:31:36 +08002528 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (needed > buf_len) {
2530 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2531 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002532
Ronald Cron40a4ab02024-01-15 10:21:30 +01002533 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
2534 p[4] = session->ticket_flags;
Jerry Yu438ddd82022-07-07 06:55:50 +00002535
2536 /* save resumption_key */
Ronald Cron40a4ab02024-01-15 10:21:30 +01002537 p[5] = session->resumption_key_len;
2538 p += 6;
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002540 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002541
Jerry Yu02e3a072022-12-12 15:13:20 +08002542#if defined(MBEDTLS_SSL_EARLY_DATA)
2543 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2544 p += 4;
2545#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002546#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2547 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2548 p += 2;
2549#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002550
Jerry Yu438ddd82022-07-07 06:55:50 +00002551#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002553 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002554 p += 8;
2555 }
2556#endif /* MBEDTLS_HAVE_TIME */
2557
2558#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002560#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002562 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002564 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002566 p += hostname_len;
2567 }
2568#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2569
Jerry Yu438ddd82022-07-07 06:55:50 +00002570#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002571 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002572 p += 8;
2573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002575 p += 4;
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002578 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 if (session->ticket != NULL && session->ticket_len > 0) {
2581 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002582 p += session->ticket_len;
2583 }
2584 }
2585#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002587}
2588
2589MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002590static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2591 const unsigned char *buf,
2592 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002593{
2594 const unsigned char *p = buf;
2595 const unsigned char *end = buf + len;
2596
Ronald Cron40a4ab02024-01-15 10:21:30 +01002597 if (end - p < 6) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2599 }
Ronald Cron40a4ab02024-01-15 10:21:30 +01002600 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
2601 session->ticket_flags = p[4];
Jerry Yu438ddd82022-07-07 06:55:50 +00002602
2603 /* load resumption_key */
Ronald Cron40a4ab02024-01-15 10:21:30 +01002604 session->resumption_key_len = p[5];
2605 p += 6;
Jerry Yu438ddd82022-07-07 06:55:50 +00002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if (end - p < session->resumption_key_len) {
2608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2609 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2613 }
2614 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002615 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002616
Jerry Yu02e3a072022-12-12 15:13:20 +08002617#if defined(MBEDTLS_SSL_EARLY_DATA)
2618 if (end - p < 4) {
2619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2620 }
2621 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2622 p += 4;
2623#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002624#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2625 if (end - p < 2) {
2626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2627 }
2628 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
2629 p += 2;
2630#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002631
Jerry Yu438ddd82022-07-07 06:55:50 +00002632#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2634 if (end - p < 8) {
2635 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2636 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002637 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002638 p += 8;
2639 }
2640#endif /* MBEDTLS_HAVE_TIME */
2641
2642#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002645 size_t hostname_len;
2646 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (end - p < 2) {
2648 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2649 }
2650 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002651 p += 2;
2652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (end - p < (long int) hostname_len) {
2654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2655 }
2656 if (hostname_len > 0) {
2657 session->hostname = mbedtls_calloc(1, hostname_len);
2658 if (session->hostname == NULL) {
2659 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2660 }
2661 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002662 p += hostname_len;
2663 }
Yanray Wangfd256542023-11-22 10:32:03 +08002664#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002665
Jerry Yu438ddd82022-07-07 06:55:50 +00002666#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (end - p < 8) {
2668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2669 }
Jerry Yu342a5552023-11-10 14:23:39 +08002670 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002671 p += 8;
2672#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (end - p < 4) {
2674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2675 }
2676 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002677 p += 4;
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (end - p < 2) {
2680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2681 }
2682 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002683 p += 2;
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if (end - p < (long int) session->ticket_len) {
2686 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2687 }
2688 if (session->ticket_len > 0) {
2689 session->ticket = mbedtls_calloc(1, session->ticket_len);
2690 if (session->ticket == NULL) {
2691 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2692 }
2693 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002694 p += session->ticket_len;
2695 }
2696 }
2697#endif /* MBEDTLS_SSL_CLI_C */
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002700
2701}
2702#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002703MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002704static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2705 unsigned char *buf,
2706 size_t buf_len,
2707 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002708{
2709 ((void) session);
2710 ((void) buf);
2711 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002712 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002714}
Jerry Yu438ddd82022-07-07 06:55:50 +00002715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2717 unsigned char *buf,
2718 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002719{
2720 ((void) session);
2721 ((void) buf);
2722 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002724}
2725#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002726#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2729 size_t taglen,
2730 psa_algorithm_t *alg,
2731 psa_key_type_t *key_type,
2732 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002734#if !defined(MBEDTLS_SSL_HAVE_CCM)
2735 (void) taglen;
2736#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002738#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002739 case MBEDTLS_CIPHER_AES_128_CBC:
2740 *alg = PSA_ALG_CBC_NO_PADDING;
2741 *key_type = PSA_KEY_TYPE_AES;
2742 *key_size = 128;
2743 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002744#endif
2745#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002746 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002748 *key_type = PSA_KEY_TYPE_AES;
2749 *key_size = 128;
2750 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002751#endif
2752#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002753 case MBEDTLS_CIPHER_AES_128_GCM:
2754 *alg = PSA_ALG_GCM;
2755 *key_type = PSA_KEY_TYPE_AES;
2756 *key_size = 128;
2757 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002758#endif
2759#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002760 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002762 *key_type = PSA_KEY_TYPE_AES;
2763 *key_size = 192;
2764 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002765#endif
2766#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002767 case MBEDTLS_CIPHER_AES_192_GCM:
2768 *alg = PSA_ALG_GCM;
2769 *key_type = PSA_KEY_TYPE_AES;
2770 *key_size = 192;
2771 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002772#endif
2773#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002774 case MBEDTLS_CIPHER_AES_256_CBC:
2775 *alg = PSA_ALG_CBC_NO_PADDING;
2776 *key_type = PSA_KEY_TYPE_AES;
2777 *key_size = 256;
2778 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002779#endif
2780#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002781 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002783 *key_type = PSA_KEY_TYPE_AES;
2784 *key_size = 256;
2785 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002786#endif
2787#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 case MBEDTLS_CIPHER_AES_256_GCM:
2789 *alg = PSA_ALG_GCM;
2790 *key_type = PSA_KEY_TYPE_AES;
2791 *key_size = 256;
2792 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002793#endif
2794#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002795 case MBEDTLS_CIPHER_ARIA_128_CBC:
2796 *alg = PSA_ALG_CBC_NO_PADDING;
2797 *key_type = PSA_KEY_TYPE_ARIA;
2798 *key_size = 128;
2799 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002800#endif
2801#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002802 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002804 *key_type = PSA_KEY_TYPE_ARIA;
2805 *key_size = 128;
2806 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002807#endif
2808#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002809 case MBEDTLS_CIPHER_ARIA_128_GCM:
2810 *alg = PSA_ALG_GCM;
2811 *key_type = PSA_KEY_TYPE_ARIA;
2812 *key_size = 128;
2813 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002814#endif
2815#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002816 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002818 *key_type = PSA_KEY_TYPE_ARIA;
2819 *key_size = 192;
2820 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002821#endif
2822#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002823 case MBEDTLS_CIPHER_ARIA_192_GCM:
2824 *alg = PSA_ALG_GCM;
2825 *key_type = PSA_KEY_TYPE_ARIA;
2826 *key_size = 192;
2827 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002828#endif
2829#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002830 case MBEDTLS_CIPHER_ARIA_256_CBC:
2831 *alg = PSA_ALG_CBC_NO_PADDING;
2832 *key_type = PSA_KEY_TYPE_ARIA;
2833 *key_size = 256;
2834 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002835#endif
2836#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002837 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002839 *key_type = PSA_KEY_TYPE_ARIA;
2840 *key_size = 256;
2841 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002842#endif
2843#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002844 case MBEDTLS_CIPHER_ARIA_256_GCM:
2845 *alg = PSA_ALG_GCM;
2846 *key_type = PSA_KEY_TYPE_ARIA;
2847 *key_size = 256;
2848 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002849#endif
2850#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002851 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2852 *alg = PSA_ALG_CBC_NO_PADDING;
2853 *key_type = PSA_KEY_TYPE_CAMELLIA;
2854 *key_size = 128;
2855 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002856#endif
2857#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002858 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002860 *key_type = PSA_KEY_TYPE_CAMELLIA;
2861 *key_size = 128;
2862 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002863#endif
2864#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002865 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2866 *alg = PSA_ALG_GCM;
2867 *key_type = PSA_KEY_TYPE_CAMELLIA;
2868 *key_size = 128;
2869 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002870#endif
2871#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002872 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002874 *key_type = PSA_KEY_TYPE_CAMELLIA;
2875 *key_size = 192;
2876 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002877#endif
2878#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002879 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2880 *alg = PSA_ALG_GCM;
2881 *key_type = PSA_KEY_TYPE_CAMELLIA;
2882 *key_size = 192;
2883 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002884#endif
2885#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002886 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2887 *alg = PSA_ALG_CBC_NO_PADDING;
2888 *key_type = PSA_KEY_TYPE_CAMELLIA;
2889 *key_size = 256;
2890 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002891#endif
2892#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002893 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002895 *key_type = PSA_KEY_TYPE_CAMELLIA;
2896 *key_size = 256;
2897 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002898#endif
2899#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002900 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2901 *alg = PSA_ALG_GCM;
2902 *key_type = PSA_KEY_TYPE_CAMELLIA;
2903 *key_size = 256;
2904 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002905#endif
2906#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002907 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2908 *alg = PSA_ALG_CHACHA20_POLY1305;
2909 *key_type = PSA_KEY_TYPE_CHACHA20;
2910 *key_size = 256;
2911 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002912#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002913 case MBEDTLS_CIPHER_NULL:
2914 *alg = MBEDTLS_SSL_NULL_CIPHER;
2915 *key_type = 0;
2916 *key_size = 0;
2917 break;
2918 default:
2919 return PSA_ERROR_NOT_SUPPORTED;
2920 }
2921
2922 return PSA_SUCCESS;
2923}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002924#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002925
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002926#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002927int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2928 const unsigned char *dhm_P, size_t P_len,
2929 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002930{
Janos Follath865b3eb2019-12-16 11:46:15 +00002931 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 mbedtls_mpi_free(&conf->dhm_P);
2934 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2937 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2938 mbedtls_mpi_free(&conf->dhm_P);
2939 mbedtls_mpi_free(&conf->dhm_G);
2940 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002941 }
2942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002944}
Paul Bakker5121ce52009-01-03 21:22:43 +00002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002947{
Janos Follath865b3eb2019-12-16 11:46:15 +00002948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 mbedtls_mpi_free(&conf->dhm_P);
2951 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2954 &conf->dhm_P)) != 0 ||
2955 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2956 &conf->dhm_G)) != 0) {
2957 mbedtls_mpi_free(&conf->dhm_P);
2958 mbedtls_mpi_free(&conf->dhm_G);
2959 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002960 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002963}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002964#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002965
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002966#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2967/*
2968 * Set the minimum length for Diffie-Hellman parameters
2969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002970void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2971 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002972{
2973 conf->dhm_min_bitlen = bitlen;
2974}
2975#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2976
Ronald Crone68ab4f2022-10-05 12:46:29 +02002977#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002978#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002979/*
2980 * Set allowed/preferred hashes for handshake signatures
2981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002982void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2983 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002984{
2985 conf->sig_hashes = hashes;
2986}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002987#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002988
Jerry Yuf017ee42022-01-12 15:49:48 +08002989/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002990void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2991 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002992{
Jerry Yuf017ee42022-01-12 15:49:48 +08002993#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2994 conf->sig_hashes = NULL;
2995#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2996 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002997}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002998#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002999
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003000#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01003001#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003002/*
3003 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003004 *
3005 * mbedtls_ssl_setup() takes the provided list
3006 * and translates it to a list of IANA TLS group identifiers,
3007 * stored in ssl->handshake->group_list.
3008 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003009 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003010void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3011 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003012{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003013 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003014 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003015}
Brett Warrene0edc842021-08-17 09:53:13 +01003016#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003017#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003018
Brett Warrene0edc842021-08-17 09:53:13 +01003019/*
3020 * Set the allowed groups
3021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003022void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3023 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003024{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003025#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003026 conf->curve_list = NULL;
3027#endif
3028 conf->group_list = group_list;
3029}
3030
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003031#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003032int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003033{
Hanno Becker947194e2017-04-07 13:25:49 +01003034 /* Initialize to suppress unnecessary compiler warning */
3035 size_t hostname_len = 0;
3036
3037 /* Check if new hostname is valid before
3038 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (hostname != NULL) {
3040 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3044 }
Hanno Becker947194e2017-04-07 13:25:49 +01003045 }
3046
3047 /* Now it's clear that we will overwrite the old hostname,
3048 * so we can free it safely */
3049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003051 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003052 }
3053
3054 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003057 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 } else {
3059 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3060 if (ssl->hostname == NULL) {
3061 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3062 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003065
Hanno Becker947194e2017-04-07 13:25:49 +01003066 ssl->hostname[hostname_len] = '\0';
3067 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003070}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003071#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003072
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003073#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003074void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3075 int (*f_sni)(void *, mbedtls_ssl_context *,
3076 const unsigned char *, size_t),
3077 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003078{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003079 conf->f_sni = f_sni;
3080 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003081}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003085int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003086{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003087 size_t cur_len, tot_len;
3088 const char **p;
3089
3090 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003091 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3092 * MUST NOT be truncated."
3093 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003094 */
3095 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 for (p = protos; *p != NULL; p++) {
3097 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003098 tot_len += cur_len;
3099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 if ((cur_len == 0) ||
3101 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3102 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3104 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003105 }
3106
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003107 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003110}
3111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003113{
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003115}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003117
Johan Pascalb62bb512015-12-03 21:56:45 +01003118#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003119void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3120 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003121{
3122 conf->dtls_srtp_mki_support = support_mki_value;
3123}
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3126 unsigned char *mki_value,
3127 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003128{
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3130 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003131 }
Ron Eldor591f1622018-01-22 12:30:04 +02003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3134 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003135 }
Ron Eldor591f1622018-01-22 12:30:04 +02003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003138 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003140}
3141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3143 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003144{
Johan Pascal253d0262020-09-22 13:04:45 +02003145 const mbedtls_ssl_srtp_profile *p;
3146 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003147
Johan Pascal253d0262020-09-22 13:04:45 +02003148 /* check the profiles list: all entry must be valid,
3149 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3151 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3152 p++) {
3153 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003154 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003156 /* unsupported value, stop parsing and set the size to an error value */
3157 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003158 }
3159 }
3160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3162 conf->dtls_srtp_profile_list = NULL;
3163 conf->dtls_srtp_profile_list_len = 0;
3164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003165 }
3166
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003167 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003168 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003171}
3172
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3174 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003175{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003176 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3177 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003179 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003181 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3183 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003184 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003185}
Johan Pascalb62bb512015-12-03 21:56:45 +01003186#endif /* MBEDTLS_SSL_DTLS_SRTP */
3187
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303188#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003189void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003190{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003191 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003192}
3193
Gilles Peskine449bd832023-01-11 14:50:10 +01003194void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003195{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003196 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003197}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303198#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003199
Janos Follath088ce432017-04-10 12:42:31 +01003200#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003201void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3202 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003203{
3204 conf->cert_req_ca_list = cert_req_ca_list;
3205}
3206#endif
3207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003209void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003211 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003212}
3213#endif
3214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003216void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003217{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003218 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003219}
3220#endif
3221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003223int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003224{
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3226 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3227 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003228 }
3229
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003230 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003233}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003237{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003238 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003239}
3240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003242void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003244 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003245}
3246
Gilles Peskine449bd832023-01-11 14:50:10 +01003247void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003248{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003249 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003250}
3251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3253 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003254{
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003256}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003260#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003261void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003262{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003263 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003264}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003265#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003266
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003267#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003268
Jerry Yud0766ec2022-09-22 10:46:57 +08003269#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003270void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3271 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003272{
Jerry Yud0766ec2022-09-22 10:46:57 +08003273 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003274}
3275#endif
3276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3278 mbedtls_ssl_ticket_write_t *f_ticket_write,
3279 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3280 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003281{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003282 conf->f_ticket_write = f_ticket_write;
3283 conf->f_ticket_parse = f_ticket_parse;
3284 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003285}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003286#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3290 mbedtls_ssl_export_keys_t *f_export_keys,
3291 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003292{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003293 ssl->f_export_keys = f_export_keys;
3294 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003295}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003296
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003297#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003298void mbedtls_ssl_conf_async_private_cb(
3299 mbedtls_ssl_config *conf,
3300 mbedtls_ssl_async_sign_t *f_async_sign,
3301 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3302 mbedtls_ssl_async_resume_t *f_async_resume,
3303 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003305{
3306 conf->f_async_sign_start = f_async_sign;
3307 conf->f_async_decrypt_start = f_async_decrypt;
3308 conf->f_async_resume = f_async_resume;
3309 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003310 conf->p_async_config_data = async_config_data;
3311}
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003314{
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003316}
3317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003319{
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (ssl->handshake == NULL) {
3321 return NULL;
3322 } else {
3323 return ssl->handshake->user_async_ctx;
3324 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003325}
3326
Gilles Peskine449bd832023-01-11 14:50:10 +01003327void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3328 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003329{
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003331 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003333}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003334#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003335
Paul Bakker5121ce52009-01-03 21:22:43 +00003336/*
3337 * SSL get accessors
3338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003339uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003340{
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 if (ssl->session != NULL) {
3342 return ssl->session->verify_result;
3343 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003344
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 if (ssl->session_negotiate != NULL) {
3346 return ssl->session_negotiate->verify_result;
3347 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003350}
3351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003353{
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 if (ssl == NULL || ssl->session == NULL) {
3355 return 0;
3356 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003359}
3360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003362{
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 if (ssl == NULL || ssl->session == NULL) {
3364 return NULL;
3365 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003366
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003368}
3369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003371{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3374 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003375 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003377 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003379 }
3380 }
3381#endif
3382
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003384 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003386 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003388 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003390 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003391}
3392
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003393#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3394
3395size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3396{
3397 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3398 size_t record_size_limit = max_len;
3399
3400 if (ssl->session != NULL &&
3401 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3402 ssl->session->record_size_limit < max_len) {
3403 record_size_limit = ssl->session->record_size_limit;
3404 }
3405
3406 // TODO: this is currently untested
3407 /* During a handshake, use the value being negotiated */
3408 if (ssl->session_negotiate != NULL &&
3409 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3410 ssl->session_negotiate->record_size_limit < max_len) {
3411 record_size_limit = ssl->session_negotiate->record_size_limit;
3412 }
3413
3414 return record_size_limit;
3415}
3416#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3417
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003418#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003419size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003420{
David Horstmann95d516f2021-05-04 18:36:56 +01003421 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003422 size_t read_mfl;
3423
Jerry Yuddda0502022-12-01 19:43:12 +08003424#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003425 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3427 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3428 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003429 }
Jerry Yuddda0502022-12-01 19:43:12 +08003430#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003431
3432 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (ssl->session_out != NULL) {
3434 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3435 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003436 max_len = read_mfl;
3437 }
3438 }
3439
Jerry Yuddda0502022-12-01 19:43:12 +08003440 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 if (ssl->session_negotiate != NULL) {
3442 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3443 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003444 max_len = read_mfl;
3445 }
3446 }
3447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003449}
3450
Gilles Peskine449bd832023-01-11 14:50:10 +01003451size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003452{
3453 size_t max_len;
3454
3455 /*
3456 * Assume mfl_code is correct since it was checked when set
3457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003459
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003460 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 if (ssl->session_out != NULL &&
3462 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3463 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003464 }
3465
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003466 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (ssl->session_negotiate != NULL &&
3468 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3469 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003470 }
3471
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003473}
3474#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3475
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003476#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003477size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003478{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003479 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3481 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3482 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3483 return 0;
3484 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3487 return ssl->mtu;
3488 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003489
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 if (ssl->mtu == 0) {
3491 return ssl->handshake->mtu;
3492 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003493
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 return ssl->mtu < ssl->handshake->mtu ?
3495 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003496}
3497#endif /* MBEDTLS_SSL_PROTO_DTLS */
3498
Gilles Peskine449bd832023-01-11 14:50:10 +01003499int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003500{
3501 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3502
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003503#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003504 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003505 !defined(MBEDTLS_SSL_PROTO_DTLS)
3506 (void) ssl;
3507#endif
3508
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003509#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003511
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003513 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003515#endif
3516
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003517#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3518 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3519
3520 if (max_len > record_size_limit) {
3521 max_len = record_size_limit;
3522 }
3523#endif
3524
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003525 if (ssl->transform_out != NULL &&
3526 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003527 /*
3528 * In TLS 1.3 case, when records are protected, `max_len` as computed
3529 * above is the maximum length of the TLSInnerPlaintext structure that
3530 * along the plaintext payload contains the inner content type (one byte)
3531 * and some zero padding. Given the algorithm used for padding
3532 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3533 * the plaintext payload. Round down to a multiple of
3534 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3535 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003536 */
3537 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3538 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3539 }
3540
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003541#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003542 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3543 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3544 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003545 const size_t overhead = (size_t) ret;
3546
Gilles Peskine449bd832023-01-11 14:50:10 +01003547 if (ret < 0) {
3548 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003549 }
3550
Gilles Peskine449bd832023-01-11 14:50:10 +01003551 if (mtu <= overhead) {
3552 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3553 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3554 }
3555
3556 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003557 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003558 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003559 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003560#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003561
Hanno Becker0defedb2018-08-10 12:35:02 +01003562#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003563 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3564 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003565 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003566#endif
3567
Gilles Peskine449bd832023-01-11 14:50:10 +01003568 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003569}
3570
Gilles Peskine449bd832023-01-11 14:50:10 +01003571int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003572{
3573 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3574
3575#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3576 (void) ssl;
3577#endif
3578
3579#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003580 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003581
Gilles Peskine449bd832023-01-11 14:50:10 +01003582 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003583 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003585#endif
3586
Gilles Peskine449bd832023-01-11 14:50:10 +01003587 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003588}
3589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003591const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003592{
Gilles Peskine449bd832023-01-11 14:50:10 +01003593 if (ssl == NULL || ssl->session == NULL) {
3594 return NULL;
3595 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003596
Hanno Beckere6824572019-02-07 13:18:46 +00003597#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003598 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003599#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003600 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003601#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003602}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003606int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3607 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003608{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003609 int ret;
3610
Gilles Peskine449bd832023-01-11 14:50:10 +01003611 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003612 dst == NULL ||
3613 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003616 }
3617
Hanno Beckere810bbc2021-05-14 16:01:05 +01003618 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3619 * idempotent: Each session can only be exported once.
3620 *
3621 * (This is in preparation for TLS 1.3 support where we will
3622 * need the ability to export multiple sessions (aka tickets),
3623 * which will be achieved by calling mbedtls_ssl_get_session()
3624 * multiple times until it fails.)
3625 *
3626 * Check whether we have already exported the current session,
3627 * and fail if so.
3628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003629 if (ssl->session->exported == 1) {
3630 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3631 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003632
Gilles Peskine449bd832023-01-11 14:50:10 +01003633 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3634 if (ret != 0) {
3635 return ret;
3636 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003637
3638 /* Remember that we've exported the session. */
3639 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003640 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003641}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003642#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003643
Paul Bakker5121ce52009-01-03 21:22:43 +00003644/*
Hanno Beckera835da52019-05-16 12:39:07 +01003645 * Define ticket header determining Mbed TLS version
3646 * and structure of the ticket.
3647 */
3648
Hanno Becker94ef3b32019-05-16 12:50:45 +01003649/*
Hanno Becker50b59662019-05-28 14:30:45 +01003650 * Define bitflag determining compile-time settings influencing
3651 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003652 */
3653
Hanno Becker50b59662019-05-28 14:30:45 +01003654#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003655#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003656#else
Hanno Becker3e088662019-05-29 11:10:18 +01003657#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003658#endif /* MBEDTLS_HAVE_TIME */
3659
3660#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003661#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003662#else
Hanno Becker3e088662019-05-29 11:10:18 +01003663#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003664#endif /* MBEDTLS_X509_CRT_PARSE_C */
3665
3666#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003667#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003668#else
Hanno Becker3e088662019-05-29 11:10:18 +01003669#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003670#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3671
3672#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003673#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003674#else
Hanno Becker3e088662019-05-29 11:10:18 +01003675#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003676#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3677
Hanno Becker94ef3b32019-05-16 12:50:45 +01003678#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003679#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003680#else
Hanno Becker3e088662019-05-29 11:10:18 +01003681#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003682#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3683
Hanno Becker94ef3b32019-05-16 12:50:45 +01003684#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3685#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3686#else
3687#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3688#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3689
Hanno Becker3e088662019-05-29 11:10:18 +01003690#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3691#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3692#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3693#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003694#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3695#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003696
Hanno Becker50b59662019-05-28 14:30:45 +01003697#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 ((uint16_t) ( \
3699 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3700 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3701 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3702 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3703 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3704 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3705 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003706
Chien Wong4e9683e2023-12-28 17:07:43 +08003707static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003708 MBEDTLS_VERSION_MAJOR,
3709 MBEDTLS_VERSION_MINOR,
3710 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003711 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3712 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003713};
Hanno Beckera835da52019-05-16 12:39:07 +01003714
3715/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003716 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003717 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003718 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003719 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003720 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003721 * opaque mbedtls_version[3]; // library version: major, minor, patch
3722 * opaque session_format[2]; // library-version specific 16-bit field
3723 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003725 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 * Note: When updating the format, remember to keep
3727 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003728 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003729 * // In this version, `session_format` determines
3730 * // the setting of those compile-time
3731 * // configuration options which influence
3732 * // the structure of mbedtls_ssl_session.
3733 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003734 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003735 * // - TLS 1.2 (0x0303)
3736 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003738 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003739 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003740 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003741 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003742 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003743 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744 *
3745 * };
3746 *
3747 * } serialized_session;
3748 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003749 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003750
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003751MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003752static int ssl_session_save(const mbedtls_ssl_session *session,
3753 unsigned char omit_header,
3754 unsigned char *buf,
3755 size_t buf_len,
3756 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003757{
3758 unsigned char *p = buf;
3759 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003760 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3762 size_t out_len;
3763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3764#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 if (session == NULL) {
3766 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3767 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003768
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003770 /*
3771 * Add Mbed TLS version identifier
3772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003774
Gilles Peskine449bd832023-01-11 14:50:10 +01003775 if (used <= buf_len) {
3776 memcpy(p, ssl_serialized_session_header,
3777 sizeof(ssl_serialized_session_header));
3778 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003779 }
3780 }
3781
3782 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003783 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003784 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003785 used += 1 /* TLS version */
3786 + 1 /* endpoint */
3787 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01003788 if (used <= buf_len) {
3789 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003790 *p++ = session->endpoint;
3791 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
3792 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003793 }
3794
3795 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003796 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003797 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003798#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003799 case MBEDTLS_SSL_VERSION_TLS1_2:
3800 used += ssl_tls12_session_save(session, p, remaining_len);
3801 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003802#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3803
Jerry Yu251a12e2022-07-13 15:15:48 +08003804#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003805 case MBEDTLS_SSL_VERSION_TLS1_3:
3806 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3807 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3808 return ret;
3809 }
3810 used += out_len;
3811 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003812#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3813
Gilles Peskine449bd832023-01-11 14:50:10 +01003814 default:
3815 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003816 }
3817
3818 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 if (used > buf_len) {
3820 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3821 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003824}
3825
3826/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003827 * Public wrapper for ssl_session_save()
3828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003829int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3830 unsigned char *buf,
3831 size_t buf_len,
3832 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003833{
Gilles Peskine449bd832023-01-11 14:50:10 +01003834 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003835}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003836
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003837/*
3838 * Deserialize session, see mbedtls_ssl_session_save() for format.
3839 *
3840 * This internal version is wrapped by a public function that cleans up in
3841 * case of error, and has an extra option omit_header.
3842 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003843MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003844static int ssl_session_load(mbedtls_ssl_session *session,
3845 unsigned char omit_header,
3846 const unsigned char *buf,
3847 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003848{
3849 const unsigned char *p = buf;
3850 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003851 size_t remaining_len;
3852
3853
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 if (session == NULL) {
3855 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3856 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003857
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003859 /*
3860 * Check Mbed TLS version identifier
3861 */
3862
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003865 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003866
3867 if (memcmp(p, ssl_serialized_session_header,
3868 sizeof(ssl_serialized_session_header)) != 0) {
3869 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3870 }
3871 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003872 }
3873
3874 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003875 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003876 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003877 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3879 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003880 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003881 session->endpoint = *p++;
3882 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
3883 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003884
3885 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003886 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003888#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003889 case MBEDTLS_SSL_VERSION_TLS1_2:
3890 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003891#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3892
Jerry Yu438ddd82022-07-07 06:55:50 +00003893#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 case MBEDTLS_SSL_VERSION_TLS1_3:
3895 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003896#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3897
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 default:
3899 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003900 }
3901}
3902
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003903/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003904 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003906int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3907 const unsigned char *buf,
3908 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003909{
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003911
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 if (ret != 0) {
3913 mbedtls_ssl_session_free(session);
3914 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003915
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003917}
3918
3919/*
Paul Bakker1961b702013-01-25 14:49:24 +01003920 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003921 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003922MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003923static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003924{
3925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3926
Ronald Cron66dbf912022-02-02 15:33:46 +01003927 /*
3928 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003929 * that were written into the output buffer by the previous handshake step,
3930 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003931 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3932 * We proceed to the next handshake step only when all data from the
3933 * previous one have been sent to the peer, thus we make sure that this is
3934 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3935 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3936 * we have to wait before to go ahead.
3937 * In the case of TLS 1.3, handshake step handlers do not send data to the
3938 * peer. Data are only sent here and through
3939 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003940 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3943 return ret;
3944 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003945
3946#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3948 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3949 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3950 return ret;
3951 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003952 }
3953#endif /* MBEDTLS_SSL_PROTO_DTLS */
3954
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003956}
3957
Gilles Peskine449bd832023-01-11 14:50:10 +01003958int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003959{
Hanno Becker41934dd2021-08-07 19:13:43 +01003960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003963 ssl->conf == NULL ||
3964 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003967 }
3968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 ret = ssl_prepare_handshake_step(ssl);
3970 if (ret != 0) {
3971 return ret;
3972 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 ret = mbedtls_ssl_handle_pending_alert(ssl);
3975 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003976 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 }
Jerry Yue7047812021-09-13 19:26:39 +08003978
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003979 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3980 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3981 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003983#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3985 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003986 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003987
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003989 case MBEDTLS_SSL_HELLO_REQUEST:
3990 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003991 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003992 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003993
Ronald Cron9f0fba32022-02-10 16:45:15 +01003994 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003996 break;
3997
3998 default:
3999#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4001 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4002 } else {
4003 ret = mbedtls_ssl_handshake_client_step(ssl);
4004 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004005#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004007#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004009#endif
4010 }
Jerry Yub9930e72021-08-06 17:11:51 +08004011 }
Ronald Cron6291b232023-03-08 15:51:25 +01004012#endif /* MBEDTLS_SSL_CLI_C */
4013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004016#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4017 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004019 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 ret = mbedtls_ssl_handshake_server_step(ssl);
4021 }
Ronald Cron6291b232023-03-08 15:51:25 +01004022#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4023 ret = mbedtls_ssl_handshake_server_step(ssl);
4024#else
4025 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004026#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004027 }
4028#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004029
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004031 /* handshake_step return error. And it is same
4032 * with alert_reason.
4033 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl->send_alert) {
4035 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004036 goto cleanup;
4037 }
4038 }
4039
4040cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004042}
4043
4044/*
4045 * Perform the SSL handshake
4046 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004047int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004048{
4049 int ret = 0;
4050
Hanno Beckera817ea42020-10-20 15:20:23 +01004051 /* Sanity checks */
4052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (ssl == NULL || ssl->conf == NULL) {
4054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4055 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004056
Hanno Beckera817ea42020-10-20 15:20:23 +01004057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4059 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4060 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4061 "mbedtls_ssl_set_timer_cb() for DTLS"));
4062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004063 }
4064#endif /* MBEDTLS_SSL_PROTO_DTLS */
4065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004067
Hanno Beckera817ea42020-10-20 15:20:23 +01004068 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4070 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004073 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 }
Paul Bakker1961b702013-01-25 14:49:24 +01004075 }
4076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004080}
4081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004082#if defined(MBEDTLS_SSL_RENEGOTIATION)
4083#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004084/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004085 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004086 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004087MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004088static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004089{
Janos Follath865b3eb2019-12-16 11:46:15 +00004090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004093
4094 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004095 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4096 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004097
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4099 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4100 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004101 }
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004104
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004106}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004108
4109/*
4110 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004111 * - any side: calling mbedtls_ssl_renegotiate(),
4112 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4113 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004114 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004115 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004116 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004118int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004119{
Janos Follath865b3eb2019-12-16 11:46:15 +00004120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if ((ret = ssl_handshake_init(ssl)) != 0) {
4125 return ret;
4126 }
Paul Bakker48916f92012-09-16 19:57:18 +00004127
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004128 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4129 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4132 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4133 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004134 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004136 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004138 }
4139#endif
4140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004141 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4142 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4145 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4146 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004147 }
4148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004152}
4153
4154/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004155 * Renegotiate current connection on client,
4156 * or request renegotiation on server
4157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004159{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004160 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004161
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (ssl == NULL || ssl->conf == NULL) {
4163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4164 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004166#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004167 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4169 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4171 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004174
4175 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (ssl->out_left != 0) {
4177 return mbedtls_ssl_flush_output(ssl);
4178 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004181 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004182#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004184#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004185 /*
4186 * On client, either start the renegotiation process or,
4187 * if already in progress, continue the handshake
4188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4190 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4191 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004192 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004193
4194 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4195 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4196 return ret;
4197 }
4198 } else {
4199 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4200 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4201 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004202 }
4203 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004204#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004205
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004207}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004208#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004211{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004212 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004215 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004217
Valerio Setti6f0441d2023-07-03 12:11:36 +02004218#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004219#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 if (ssl->handshake->group_list_heap_allocated) {
4221 mbedtls_free((void *) handshake->group_list);
4222 }
Brett Warrene0edc842021-08-17 09:53:13 +01004223 handshake->group_list = NULL;
4224#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004225#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004226
Ronald Crone68ab4f2022-10-05 12:46:29 +02004227#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004228#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (ssl->handshake->sig_algs_heap_allocated) {
4230 mbedtls_free((void *) handshake->sig_algs);
4231 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004232 handshake->sig_algs = NULL;
4233#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004234#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (ssl->handshake->certificate_request_context) {
4236 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004237 }
4238#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004239#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004240
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004241#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4243 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004244 handshake->async_in_progress = 0;
4245 }
4246#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4247
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004248#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004249#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004251#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004252 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004253#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004254#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004255#if defined(MBEDTLS_MD_CAN_SHA384)
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_sha384_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_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004260#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004261#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004263#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004265#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004266#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004267 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004269#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004270
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004271#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004272#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004274 /*
4275 * Opaque keys are not stored in the handshake's data and it's the user
4276 * responsibility to destroy them. Clear ones, instead, are created by
4277 * the TLS library and should be destroyed at the same level
4278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4280 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004281 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004282 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4283#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004286#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004288 handshake->ecjpake_cache = NULL;
4289 handshake->ecjpake_cache_len = 0;
4290#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004291#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004292
Valerio Setti7aeec542023-07-05 18:57:21 +02004293#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004294 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004295 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004296 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004298#endif
4299
Ronald Cron73fe8df2022-10-05 14:31:43 +02004300#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004301#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004303 /* The maintenance of the external PSK key slot is the
4304 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (ssl->handshake->psk_opaque_is_internal) {
4306 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004307 ssl->handshake->psk_opaque_is_internal = 0;
4308 }
4309 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4310 }
Neil Armstronge952a302022-05-03 10:22:14 +02004311#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004313 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004314 }
Neil Armstronge952a302022-05-03 10:22:14 +02004315#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004316#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4319 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004320 /*
4321 * Free only the linked list wrapper, not the keys themselves
4322 * since the belong to the SNI callback
4323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004325#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004326
Gilles Peskineeccd8882020-03-10 12:19:08 +01004327#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4329 if (handshake->ecrs_peer_cert != NULL) {
4330 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4331 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004332 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004333#endif
4334
Hanno Becker75173122019-02-06 16:18:31 +00004335#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4336 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004338#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4339
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004340#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4342 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004343#endif /* MBEDTLS_SSL_CLI_C &&
4344 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004345
4346#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 mbedtls_ssl_flight_free(handshake->flight);
4348 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004349#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004350
Valerio Settiea59c432023-07-25 11:14:03 +02004351#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004352 if (handshake->xxdh_psa_privkey_is_external == 0) {
4353 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 }
Valerio Settiea59c432023-07-25 11:14:03 +02004355#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004356
Ronald Cron6f135e12021-12-08 16:57:54 +01004357#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 mbedtls_ssl_transform_free(handshake->transform_handshake);
4359 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004360#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4362 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004363#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004364#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004365
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004366
4367#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4368 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4369 * processes datagrams and the fact that a datagram is allowed to have
4370 * several records in it, it is possible that the I/O buffers are not
4371 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4373 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004374#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004375
Jerry Yuba9c7272021-10-30 11:54:10 +08004376 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 mbedtls_platform_zeroize(handshake,
4378 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004379}
4380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004382{
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004384 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004389#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004390
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004391#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004392#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4393 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004397#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004400}
4401
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004402#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004403
4404#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4405#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4406#else
4407#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4408#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4409
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004410#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004411
4412#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4413#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4414#else
4415#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4416#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4417
4418#if defined(MBEDTLS_SSL_ALPN)
4419#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4420#else
4421#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4422#endif /* MBEDTLS_SSL_ALPN */
4423
4424#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4425#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4426#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4427#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4428
4429#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 ((uint32_t) ( \
4431 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4432 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4433 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4434 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4435 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4436 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4437 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4438 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004439
Chien Wong4e9683e2023-12-28 17:07:43 +08004440static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004441 MBEDTLS_VERSION_MAJOR,
4442 MBEDTLS_VERSION_MINOR,
4443 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4445 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4446 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4447 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4448 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004449};
4450
Paul Bakker5121ce52009-01-03 21:22:43 +00004451/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004452 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004453 *
4454 * The format of the serialized data is:
4455 * (in the presentation language of TLS, RFC 8446 section 3)
4456 *
4457 * // header
4458 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004459 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004460 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004461 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004462 * Note: When updating the format, remember to keep these
4463 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004464 *
4465 * // session sub-structure
4466 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4467 * // transform sub-structure
4468 * uint8 random[64]; // ServerHello.random+ClientHello.random
4469 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4470 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4471 * // fields from ssl_context
4472 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4473 * uint64 in_window_top; // DTLS: last validated record seq_num
4474 * uint64 in_window; // DTLS: bitmask for replay protection
4475 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4476 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4477 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4478 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4479 *
4480 * Note that many fields of the ssl_context or sub-structures are not
4481 * serialized, as they fall in one of the following categories:
4482 *
4483 * 1. forced value (eg in_left must be 0)
4484 * 2. pointer to dynamically-allocated memory (eg session, transform)
4485 * 3. value can be re-derived from other data (eg session keys from MS)
4486 * 4. value was temporary (eg content of input buffer)
4487 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004489int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4490 unsigned char *buf,
4491 size_t buf_len,
4492 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004493{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004494 unsigned char *p = buf;
4495 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004496 size_t session_len;
4497 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004498
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004499 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004500 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4501 * this function's documentation.
4502 *
4503 * These are due to assumptions/limitations in the implementation. Some of
4504 * them are likely to stay (no handshake in progress) some might go away
4505 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004506 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004507 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4509 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004511 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (ssl->handshake != NULL) {
4513 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004515 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004516 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (ssl->transform == NULL || ssl->session == NULL) {
4518 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4519 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004520 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004521 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 if (mbedtls_ssl_check_pending(ssl) != 0) {
4523 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4524 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004525 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (ssl->out_left != 0) {
4527 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4528 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004529 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004530 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4532 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4533 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004534 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004535 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4537 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4538 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004539 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004540 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4542 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4543 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004544 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004545 /* Renegotiation must not be enabled */
4546#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4548 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4549 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004550 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004551#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004552
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004553 /*
4554 * Version and format identifier
4555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004557
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (used <= buf_len) {
4559 memcpy(p, ssl_serialized_context_header,
4560 sizeof(ssl_serialized_context_header));
4561 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004562 }
4563
4564 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004565 * Session (length + data)
4566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4568 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4569 return ret;
4570 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004571
4572 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (used <= buf_len) {
4574 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004575 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 ret = ssl_session_save(ssl->session, 1,
4578 p, session_len, &session_len);
4579 if (ret != 0) {
4580 return ret;
4581 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004582
4583 p += session_len;
4584 }
4585
4586 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004587 * Transform
4588 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 used += sizeof(ssl->transform->randbytes);
4590 if (used <= buf_len) {
4591 memcpy(p, ssl->transform->randbytes,
4592 sizeof(ssl->transform->randbytes));
4593 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004594 }
4595
4596#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004597 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004599 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004601 p += ssl->transform->in_cid_len;
4602
4603 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004605 p += ssl->transform->out_cid_len;
4606 }
4607#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4608
4609 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004610 * Saved fields from top-level ssl_context structure
4611 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004612 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if (used <= buf_len) {
4614 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004615 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004616 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004617
4618#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4619 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (used <= buf_len) {
4621 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004622 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004625 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004626 }
4627#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4628
4629#if defined(MBEDTLS_SSL_PROTO_DTLS)
4630 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004632 *p++ = ssl->disable_datagram_packing;
4633 }
4634#endif /* MBEDTLS_SSL_PROTO_DTLS */
4635
Jerry Yuae0b2e22021-10-08 15:21:19 +08004636 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (used <= buf_len) {
4638 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004639 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004640 }
4641
4642#if defined(MBEDTLS_SSL_PROTO_DTLS)
4643 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (used <= buf_len) {
4645 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004646 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004647 }
4648#endif /* MBEDTLS_SSL_PROTO_DTLS */
4649
4650#if defined(MBEDTLS_SSL_ALPN)
4651 {
4652 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004654 : 0;
4655
4656 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004658 *p++ = alpn_len;
4659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if (ssl->alpn_chosen != NULL) {
4661 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004662 p += alpn_len;
4663 }
4664 }
4665 }
4666#endif /* MBEDTLS_SSL_ALPN */
4667
4668 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004669 * Done
4670 */
4671 *olen = used;
4672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 if (used > buf_len) {
4674 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4675 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004680}
4681
4682/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004683 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004684 *
4685 * This internal version is wrapped by a public function that cleans up in
4686 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004687 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004688MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004689static int ssl_context_load(mbedtls_ssl_context *ssl,
4690 const unsigned char *buf,
4691 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004692{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004693 const unsigned char *p = buf;
4694 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004695 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004697#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004698 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004699#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004700
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004701 /*
4702 * The context should have been freshly setup or reset.
4703 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004704 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004705 * renegotiating, or if the user mistakenly loaded a session first.)
4706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4708 ssl->session != NULL) {
4709 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004710 }
4711
4712 /*
4713 * We can't check that the config matches the initial one, but we can at
4714 * least check it matches the requirements for serializing.
4715 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004716 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004717#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004718 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004719#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004720 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4721 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4722 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4723 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004725 }
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004728
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004729 /*
4730 * Check version identifier
4731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004734 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004735
4736 if (memcmp(p, ssl_serialized_context_header,
4737 sizeof(ssl_serialized_context_header)) != 0) {
4738 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4739 }
4740 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004741
4742 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004743 * Session
4744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if ((size_t) (end - p) < 4) {
4746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4747 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004748
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004749 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004750 p += 4;
4751
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004752 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004753 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004754 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004755 ssl->session_in = ssl->session;
4756 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004757 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if ((size_t) (end - p) < session_len) {
4760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4761 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 ret = ssl_session_load(ssl->session, 1, p, session_len);
4764 if (ret != 0) {
4765 mbedtls_ssl_session_free(ssl->session);
4766 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004767 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004768
4769 p += session_len;
4770
4771 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004772 * Transform
4773 */
4774
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004775 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004776 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004777#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004778 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004779 ssl->transform_in = ssl->transform;
4780 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004781 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004782#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004783
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004784#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4786 if (prf_func == NULL) {
4787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4788 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004789
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004790 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4793 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004794
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 ret = ssl_tls12_populate_transform(ssl->transform,
4796 ssl->session->ciphersuite,
4797 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004798#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004800#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 prf_func,
4802 p, /* currently pointing to randbytes */
4803 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4804 ssl->conf->endpoint,
4805 ssl);
4806 if (ret != 0) {
4807 return ret;
4808 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004809#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004811
4812#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4813 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if ((size_t) (end - p) < 1) {
4815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4816 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004817
4818 ssl->transform->in_cid_len = *p++;
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4821 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4822 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004825 p += ssl->transform->in_cid_len;
4826
4827 ssl->transform->out_cid_len = *p++;
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4831 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004834 p += ssl->transform->out_cid_len;
4835#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4836
4837 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004838 * Saved fields from top-level ssl_context structure
4839 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if ((size_t) (end - p) < 4) {
4841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4842 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004843
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004844 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004846
4847#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if ((size_t) (end - p) < 16) {
4849 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4850 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004851
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004852 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004853 p += 8;
4854
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004855 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004856 p += 8;
4857#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4858
4859#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if ((size_t) (end - p) < 1) {
4861 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4862 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004863
4864 ssl->disable_datagram_packing = *p++;
4865#endif /* MBEDTLS_SSL_PROTO_DTLS */
4866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4869 }
4870 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4871 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004872
4873#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if ((size_t) (end - p) < 2) {
4875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4876 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004877
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004878 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879 p += 2;
4880#endif /* MBEDTLS_SSL_PROTO_DTLS */
4881
4882#if defined(MBEDTLS_SSL_ALPN)
4883 {
4884 uint8_t alpn_len;
4885 const char **cur;
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if ((size_t) (end - p) < 1) {
4888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4889 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004890
4891 alpn_len = *p++;
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004894 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4896 if (strlen(*cur) == alpn_len &&
4897 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004898 ssl->alpn_chosen = *cur;
4899 break;
4900 }
4901 }
4902 }
4903
4904 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4907 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004908
4909 p += alpn_len;
4910 }
4911#endif /* MBEDTLS_SSL_ALPN */
4912
4913 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004914 * Forced fields from top-level ssl_context structure
4915 *
4916 * Most of them already set to the correct value by mbedtls_ssl_init() and
4917 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4918 */
4919 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004920 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004921
Hanno Becker361b10d2019-08-30 10:42:49 +01004922 /* Adjust pointers for header fields of outgoing records to
4923 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004925
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004926#if defined(MBEDTLS_SSL_PROTO_DTLS)
4927 ssl->in_epoch = 1;
4928#endif
4929
4930 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4931 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004932 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4933 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 if (ssl->handshake != NULL) {
4935 mbedtls_ssl_handshake_free(ssl);
4936 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004937 ssl->handshake = NULL;
4938 }
4939
4940 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004941 * Done - should have consumed entire buffer
4942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (p != end) {
4944 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4945 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004948}
4949
4950/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004951 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004953int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4954 const unsigned char *buf,
4955 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004956{
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (ret != 0) {
4960 mbedtls_ssl_free(context);
4961 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004964}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004965#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004966
4967/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004968 * Free an SSL context
4969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004971{
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004973 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004979#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4980 size_t out_buf_len = ssl->out_buf_len;
4981#else
4982 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4983#endif
4984
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004985 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004986 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004987 }
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004990#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4991 size_t in_buf_len = ssl->in_buf_len;
4992#else
4993 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4994#endif
4995
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004996 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004997 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004998 }
4999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if (ssl->transform) {
5001 mbedtls_ssl_transform_free(ssl->transform);
5002 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005003 }
5004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 if (ssl->handshake) {
5006 mbedtls_ssl_handshake_free(ssl);
5007 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005008
5009#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5011 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005012#endif
5013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 mbedtls_ssl_session_free(ssl->session_negotiate);
5015 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005016 }
5017
Ronald Cron6f135e12021-12-08 16:57:54 +01005018#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 mbedtls_ssl_transform_free(ssl->transform_application);
5020 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005021#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 if (ssl->session) {
5024 mbedtls_ssl_session_free(ssl->session);
5025 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005026 }
5027
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005028#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005030 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005031 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005032#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005033
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005034#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005036#endif
5037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005039
Paul Bakker86f04f42013-02-14 11:20:09 +01005040 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005042}
5043
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005044/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005045 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005046 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005047void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005048{
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005050}
5051
Gilles Peskineae270bf2021-06-02 00:05:29 +02005052/* The selection should be the same as mbedtls_x509_crt_profile_default in
5053 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005054 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005055 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005056 * about this list.
5057 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005058static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005059#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005060 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005061#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005062#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005063 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005064#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005065#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005066 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005067#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005068#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005069 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005070#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005071#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005072 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005073#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005074#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005075 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005076#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005077#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005078 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005079#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005080#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005081 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005082#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005083#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005084 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5085 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5086 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5087 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5088 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5089#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005090 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005091};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005092
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005093static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005094 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5095 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5096 0
5097};
5098
Ronald Crone68ab4f2022-10-05 12:46:29 +02005099#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005100
Jerry Yu909df7b2022-01-22 11:56:27 +08005101/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005102 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005103 * rules SHOULD be upheld.
5104 * - No duplicate entries.
5105 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005106 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005107 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005108 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005109static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005110
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005111#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005112 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005113 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005114 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005115 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5116#endif
Jerry Yu909df7b2022-01-22 11:56:27 +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_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005120 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005121 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005122 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
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_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005127 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005128 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005129 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5130#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005131
Yanray Wang1136fad2023-11-22 16:54:31 +08005132#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005133 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005134#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005135
Yanray Wang1136fad2023-11-22 16:54:31 +08005136#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005137 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005138#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005139
Yanray Wang1136fad2023-11-22 16:54:31 +08005140#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005141 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005142#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005143
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005144#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005145 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005146#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005147
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005148#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005149 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005150#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005151
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005152#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005153 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005154#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005155
Gabor Mezei15b95a62022-05-09 16:37:58 +02005156 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005157};
5158
5159/* NOTICE: see above */
5160#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5161static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005162
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005163#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005164#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005166#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005167#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5168 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005169#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005170#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005172#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005173#endif /* MBEDTLS_MD_CAN_SHA512 */
5174
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005175#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005176#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005178#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005179#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5180 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005181#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005182#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005184#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005185#endif /* MBEDTLS_MD_CAN_SHA384 */
5186
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005187#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005188#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005190#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005191#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5192 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005193#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005194#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005196#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005197#endif /* MBEDTLS_MD_CAN_SHA256 */
5198
Gabor Mezei15b95a62022-05-09 16:37:58 +02005199 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005200};
5201#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005202
Jerry Yu909df7b2022-01-22 11:56:27 +08005203/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005204static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005205
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005206#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005207 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005208 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005209 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005210 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5211#endif
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_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005215 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005216 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005217 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5218#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005219
Gabor Mezei15b95a62022-05-09 16:37:58 +02005220 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005221};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005222
Jerry Yu909df7b2022-01-22 11:56:27 +08005223/* NOTICE: see above */
5224#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5225static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005226
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005227#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005228#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005230#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005231#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005232
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005233#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005234#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005236#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005237#endif /* MBEDTLS_MD_CAN_SHA384 */
5238
Gabor Mezei15b95a62022-05-09 16:37:58 +02005239 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005240};
Jerry Yu909df7b2022-01-22 11:56:27 +08005241#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5242
Ronald Crone68ab4f2022-10-05 12:46:29 +02005243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005244
Chien Wong4e9683e2023-12-28 17:07:43 +08005245static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005246#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005247 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005248#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005249#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005250 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005251#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005252 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005253};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005254
Ronald Crone68ab4f2022-10-05 12:46:29 +02005255#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005256/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005257 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005258MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005259static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005260{
5261 size_t i, j;
5262 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5265 for (j = 0; j < i; j++) {
5266 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005267 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 }
5269 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5270 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5271 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005272 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005273 }
5274 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005276}
5277
Ronald Crone68ab4f2022-10-05 12:46:29 +02005278#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005279
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005280/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005281 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005283int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5284 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005285{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005286#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005288#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005289
Ronald Crone68ab4f2022-10-05 12:46:29 +02005290#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5292 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5293 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005294 }
5295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5297 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5298 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005299 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005300
5301#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5303 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5304 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005305 }
5306
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5308 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5309 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005310 }
5311#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005312#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005313
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005314 /* Use the functions here so that they are covered in tests,
5315 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 mbedtls_ssl_conf_endpoint(conf, endpoint);
5317 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005318
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319 /*
5320 * Things that are common to all presets
5321 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005322#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005324 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5325#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5326 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5327#endif
5328 }
5329#endif
5330
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005331#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5332 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5333#endif
5334
5335#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5336 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5337#endif
5338
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005339#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005340 conf->f_cookie_write = ssl_cookie_write_dummy;
5341 conf->f_cookie_check = ssl_cookie_check_dummy;
5342#endif
5343
5344#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5345 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5346#endif
5347
Janos Follath088ce432017-04-10 12:42:31 +01005348#if defined(MBEDTLS_SSL_SRV_C)
5349 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005350 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005351#endif
5352
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005353#if defined(MBEDTLS_SSL_PROTO_DTLS)
5354 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5355 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5356#endif
5357
5358#if defined(MBEDTLS_SSL_RENEGOTIATION)
5359 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 memset(conf->renego_period, 0x00, 2);
5361 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005362#endif
5363
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005366 const unsigned char dhm_p[] =
5367 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5368 const unsigned char dhm_g[] =
5369 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005370
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5372 dhm_p, sizeof(dhm_p),
5373 dhm_g, sizeof(dhm_g))) != 0) {
5374 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005375 }
5376 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005377#endif
5378
Ronald Cron6f135e12021-12-08 16:57:54 +01005379#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005380
5381#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005382 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005383#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005384 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005385#endif
5386#endif /* MBEDTLS_SSL_EARLY_DATA */
5387
Jerry Yud0766ec2022-09-22 10:46:57 +08005388#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005389 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005391#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005392 /*
5393 * Allow all TLS 1.3 key exchange modes by default.
5394 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005395 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005396#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005399#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005400 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005401 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005402#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005406#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005407 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5408 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005409#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5410 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5411 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5412#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5413 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5414 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5415#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005417#endif
5418 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005419
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005420 /*
5421 * Preset-specific defaults
5422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005424 /*
5425 * NSA Suite B
5426 */
5427 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005428
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005429 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005430
5431#if defined(MBEDTLS_X509_CRT_PARSE_C)
5432 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005433#endif
5434
Ronald Crone68ab4f2022-10-05 12:46:29 +02005435#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005436#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005438 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005440#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005442#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005443
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005444#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005445 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005446#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005447 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005448 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005449
5450 /*
5451 * Default
5452 */
5453 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005454
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005455 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005456
5457#if defined(MBEDTLS_X509_CRT_PARSE_C)
5458 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5459#endif
5460
Ronald Crone68ab4f2022-10-05 12:46:29 +02005461#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005462#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005464 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005466#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005468#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005469
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005470#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005471 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005472#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005473 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005474
5475#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5476 conf->dhm_min_bitlen = 1024;
5477#endif
5478 }
5479
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005481}
5482
5483/*
5484 * Free mbedtls_ssl_config
5485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005486void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005487{
5488#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 mbedtls_mpi_free(&conf->dhm_P);
5490 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005491#endif
5492
Ronald Cron73fe8df2022-10-05 14:31:43 +02005493#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005494#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005496 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5497 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005498#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005500 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005501 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005502 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005503 }
5504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005506 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005507 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005508 conf->psk_identity_len = 0;
5509 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005510#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005511
5512#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005514#endif
5515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005517}
5518
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005519#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005520 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005521/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005524unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005525{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5528 return MBEDTLS_SSL_SIG_RSA;
5529 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005530#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005531#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5533 return MBEDTLS_SSL_SIG_ECDSA;
5534 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005535#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005537}
5538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005540{
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005542 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005544 case MBEDTLS_PK_ECDSA:
5545 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005547 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005549 }
5550}
5551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005555#if defined(MBEDTLS_RSA_C)
5556 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005558#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005559#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005560 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005562#endif
5563 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005565 }
5566}
Valerio Settie9646ec2023-08-02 20:02:28 +02005567#endif /* MBEDTLS_PK_C &&
5568 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005569
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005570/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005571 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005574{
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005576#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005577 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005579#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005580#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005581 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005583#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005584#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005585 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005587#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005588#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005589 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005591#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005592#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005595#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005596#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005599#endif
5600 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005602 }
5603}
5604
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005605/*
5606 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005609{
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005611#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005612 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005614#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005615#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005616 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005618#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005619#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005620 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005622#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005623#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005624 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005626#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005627#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005628 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005630#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005631#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005632 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005634#endif
5635 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005637 }
5638}
5639
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005640/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005641 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005642 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005644int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005645{
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005647
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 if (group_list == NULL) {
5649 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005650 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005651
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 for (; *group_list != 0; group_list++) {
5653 if (*group_list == tls_id) {
5654 return 0;
5655 }
5656 }
5657
5658 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005659}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005660
Valerio Setti49e69072023-06-27 17:27:51 +02005661#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005662/*
5663 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005665int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005666{
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005668
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005670 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005674}
Valerio Setti49e69072023-06-27 17:27:51 +02005675#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005676
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677static const struct {
5678 uint16_t tls_id;
5679 mbedtls_ecp_group_id ecp_group_id;
5680 psa_ecc_family_t psa_family;
5681 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682} tls_id_match_table[] =
5683{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005684#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005685 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005686#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005687#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005688 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005689#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005690#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005691 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005692#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005693#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005694 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005695#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005696#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005697 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005698#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005699#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005700 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005701#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005702#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005703 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005704#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005705#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005706 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005707#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005708#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005709 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005710#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005711#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005712 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005713#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005714#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005715 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005716#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005717#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005718 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005719#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005720#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005721 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005722#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005723 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005724};
5725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005727 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005729{
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5731 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005732 if (type != NULL) {
5733 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 }
5735 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005736 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005738 return PSA_SUCCESS;
5739 }
5740 }
5741
5742 return PSA_ERROR_NOT_SUPPORTED;
5743}
5744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005746{
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5748 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005749 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005751 }
5752
5753 return MBEDTLS_ECP_DP_NONE;
5754}
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005757{
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5759 i++) {
5760 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005761 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005763 }
5764
5765 return 0;
5766}
5767
Valerio Setti67419f02023-01-04 16:12:42 +01005768#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005769static const struct {
5770 uint16_t tls_id;
5771 const char *name;
5772} tls_id_curve_name_table[] =
5773{
Valerio Setti54e23792023-07-07 10:49:27 +02005774 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5775 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5776 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5777 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5778 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5779 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5780 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5781 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5782 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5783 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5784 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5785 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5786 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005787 { 0, NULL },
5788};
5789
Gilles Peskine449bd832023-01-11 14:50:10 +01005790const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005791{
Valerio Settiacd32c02023-06-29 18:06:29 +02005792 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5793 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5794 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005796 }
5797
5798 return NULL;
5799}
Valerio Setti67419f02023-01-04 16:12:42 +01005800#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5804 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5805 int cert_endpoint,
5806 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005807{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005808 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005809 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005810 const char *ext_oid;
5811 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005812
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005814 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005816 case MBEDTLS_KEY_EXCHANGE_RSA:
5817 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005818 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005819 break;
5820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005821 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5822 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5823 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5824 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005825 break;
5826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005827 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5828 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005829 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005830 break;
5831
5832 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005833 case MBEDTLS_KEY_EXCHANGE_NONE:
5834 case MBEDTLS_KEY_EXCHANGE_PSK:
5835 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5836 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005837 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005838 usage = 0;
5839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005841 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5842 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005843 }
5844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005846 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005847 ret = -1;
5848 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005851 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5853 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005854 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005856 }
5857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005859 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005860 ret = -1;
5861 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005864}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005865#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005866
Jerry Yu148165c2021-09-24 23:20:59 +08005867#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005868int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5869 const mbedtls_md_type_t md,
5870 unsigned char *dst,
5871 size_t dst_len,
5872 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005873{
Ronald Cronf6893e12022-01-07 22:09:01 +01005874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5875 psa_hash_operation_t *hash_operation_to_clone;
5876 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5877
Jerry Yu148165c2021-09-24 23:20:59 +08005878 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005881#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 case MBEDTLS_MD_SHA384:
5883 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5884 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005885#endif
5886
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005887#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 case MBEDTLS_MD_SHA256:
5889 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5890 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005891#endif
5892
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 default:
5894 goto exit;
5895 }
5896
5897 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5898 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005899 goto exit;
5900 }
5901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5903 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005904 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005906
5907exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005908#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5909 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005910 (void) ssl;
5911#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005912 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005913}
5914#else /* MBEDTLS_USE_PSA_CRYPTO */
5915
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005916#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005917MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005918static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5919 unsigned char *dst,
5920 size_t dst_len,
5921 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005922{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005923 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005924 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (dst_len < 48) {
5927 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5928 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005929
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005930 mbedtls_md_init(&sha384);
5931 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005932 if (ret != 0) {
5933 goto exit;
5934 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005935 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005936 if (ret != 0) {
5937 goto exit;
5938 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005939
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005940 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005941 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005942 goto exit;
5943 }
5944
5945 *olen = 48;
5946
5947exit:
5948
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005949 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005951}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005952#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005954#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005956static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5957 unsigned char *dst,
5958 size_t dst_len,
5959 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005960{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005961 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005962 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (dst_len < 32) {
5965 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5966 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005967
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005968 mbedtls_md_init(&sha256);
5969 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5970 if (ret != 0) {
5971 goto exit;
5972 }
5973 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5974 if (ret != 0) {
5975 goto exit;
5976 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005977
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005978 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5979 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005980 goto exit;
5981 }
5982
5983 *olen = 32;
5984
5985exit:
5986
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005987 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005989}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005990#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005991
Gilles Peskine449bd832023-01-11 14:50:10 +01005992int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5993 const mbedtls_md_type_t md,
5994 unsigned char *dst,
5995 size_t dst_len,
5996 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005997{
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005999
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006000#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 case MBEDTLS_MD_SHA384:
6002 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006003#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006004
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006005#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 case MBEDTLS_MD_SHA256:
6007 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006008#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006011#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6012 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 (void) ssl;
6014 (void) dst;
6015 (void) dst_len;
6016 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006017#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006019 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006021}
XiaokangQian647719a2021-12-07 09:16:29 +00006022
Jerry Yu148165c2021-09-24 23:20:59 +08006023#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006024
Ronald Crone68ab4f2022-10-05 12:46:29 +02006025#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006026/* mbedtls_ssl_parse_sig_alg_ext()
6027 *
6028 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6029 * value (TLS 1.3 RFC8446):
6030 * enum {
6031 * ....
6032 * ecdsa_secp256r1_sha256( 0x0403 ),
6033 * ecdsa_secp384r1_sha384( 0x0503 ),
6034 * ecdsa_secp521r1_sha512( 0x0603 ),
6035 * ....
6036 * } SignatureScheme;
6037 *
6038 * struct {
6039 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6040 * } SignatureSchemeList;
6041 *
6042 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6043 * value (TLS 1.2 RFC5246):
6044 * enum {
6045 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6046 * sha512(6), (255)
6047 * } HashAlgorithm;
6048 *
6049 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6050 * SignatureAlgorithm;
6051 *
6052 * struct {
6053 * HashAlgorithm hash;
6054 * SignatureAlgorithm signature;
6055 * } SignatureAndHashAlgorithm;
6056 *
6057 * SignatureAndHashAlgorithm
6058 * supported_signature_algorithms<2..2^16-2>;
6059 *
6060 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6061 * generalization of the TLS 1.2 signature algorithm extension.
6062 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6063 * `SignatureScheme` field of TLS 1.3
6064 *
6065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006066int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6067 const unsigned char *buf,
6068 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006069{
6070 const unsigned char *p = buf;
6071 size_t supported_sig_algs_len = 0;
6072 const unsigned char *supported_sig_algs_end;
6073 uint16_t sig_alg;
6074 uint32_t common_idx = 0;
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6077 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006078 p += 2;
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 memset(ssl->handshake->received_sig_algs, 0,
6081 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006084 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 while (p < supported_sig_algs_end) {
6086 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6087 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006088 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6090 sig_alg,
6091 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6094 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6095 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006096 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006097 }
6098#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6101 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006104 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6105 common_idx += 1;
6106 }
6107 }
6108 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (p != end) {
6110 MBEDTLS_SSL_DEBUG_MSG(1,
6111 ("Signature algorithms extension length misaligned"));
6112 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6113 MBEDTLS_ERR_SSL_DECODE_ERROR);
6114 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006115 }
6116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (common_idx == 0) {
6118 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6119 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6120 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6121 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006122 }
6123
Gabor Mezei15b95a62022-05-09 16:37:58 +02006124 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006126}
6127
Ronald Crone68ab4f2022-10-05 12:46:29 +02006128#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006129
Jerry Yudc7bd172022-02-17 13:44:15 +08006130#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6131
6132#if defined(MBEDTLS_USE_PSA_CRYPTO)
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6135 mbedtls_svc_key_id_t key,
6136 psa_algorithm_t alg,
6137 const unsigned char *raw_psk, size_t raw_psk_length,
6138 const unsigned char *seed, size_t seed_length,
6139 const unsigned char *label, size_t label_length,
6140 const unsigned char *other_secret,
6141 size_t other_secret_length,
6142 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006143{
6144 psa_status_t status;
6145
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 status = psa_key_derivation_setup(derivation, alg);
6147 if (status != PSA_SUCCESS) {
6148 return status;
6149 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6152 status = psa_key_derivation_input_bytes(derivation,
6153 PSA_KEY_DERIVATION_INPUT_SEED,
6154 seed, seed_length);
6155 if (status != PSA_SUCCESS) {
6156 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006157 }
6158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 if (other_secret != NULL) {
6160 status = psa_key_derivation_input_bytes(derivation,
6161 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6162 other_secret, other_secret_length);
6163 if (status != PSA_SUCCESS) {
6164 return status;
6165 }
6166 }
6167
6168 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006169 status = psa_key_derivation_input_bytes(
6170 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 raw_psk, raw_psk_length);
6172 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006173 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (status != PSA_SUCCESS) {
6177 return status;
6178 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 status = psa_key_derivation_input_bytes(derivation,
6181 PSA_KEY_DERIVATION_INPUT_LABEL,
6182 label, label_length);
6183 if (status != PSA_SUCCESS) {
6184 return status;
6185 }
6186 } else {
6187 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 }
6189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 status = psa_key_derivation_set_capacity(derivation, capacity);
6191 if (status != PSA_SUCCESS) {
6192 return status;
6193 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006196}
6197
Andrzej Kurek57d10632022-10-24 10:32:01 -04006198#if defined(PSA_WANT_ALG_SHA_384) || \
6199 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006201static int tls_prf_generic(mbedtls_md_type_t md_type,
6202 const unsigned char *secret, size_t slen,
6203 const char *label,
6204 const unsigned char *random, size_t rlen,
6205 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006206{
6207 psa_status_t status;
6208 psa_algorithm_t alg;
6209 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6210 psa_key_derivation_operation_t derivation =
6211 PSA_KEY_DERIVATION_OPERATION_INIT;
6212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006214 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006218
6219 /* Normally a "secret" should be long enough to be impossible to
6220 * find by brute force, and in particular should not be empty. But
6221 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6222 * and for this use case it makes sense to have a 0-length "secret".
6223 * Since the key API doesn't allow importing a key of length 0,
6224 * keep master_key=0, which setup_psa_key_derivation() understands
6225 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006227 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6229 psa_set_key_algorithm(&key_attributes, alg);
6230 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6233 if (status != PSA_SUCCESS) {
6234 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6235 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006236 }
6237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 status = setup_psa_key_derivation(&derivation,
6239 master_key, alg,
6240 NULL, 0,
6241 random, rlen,
6242 (unsigned char const *) label,
6243 (size_t) strlen(label),
6244 NULL, 0,
6245 dlen);
6246 if (status != PSA_SUCCESS) {
6247 psa_key_derivation_abort(&derivation);
6248 psa_destroy_key(master_key);
6249 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 }
6251
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 status = psa_key_derivation_output_bytes(&derivation, dstbuf, 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_abort(&derivation);
6260 if (status != PSA_SUCCESS) {
6261 psa_destroy_key(master_key);
6262 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006263 }
6264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 if (!mbedtls_svc_key_id_is_null(master_key)) {
6266 status = psa_destroy_key(master_key);
6267 }
6268 if (status != PSA_SUCCESS) {
6269 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6270 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006273}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006274#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006275#else /* MBEDTLS_USE_PSA_CRYPTO */
6276
Andrzej Kurek57d10632022-10-24 10:32:01 -04006277#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006278 (defined(MBEDTLS_MD_CAN_SHA256) || \
6279 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006281static int tls_prf_generic(mbedtls_md_type_t md_type,
6282 const unsigned char *secret, size_t slen,
6283 const char *label,
6284 const unsigned char *random, size_t rlen,
6285 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006286{
6287 size_t nb;
6288 size_t i, j, k, md_len;
6289 unsigned char *tmp;
6290 size_t tmp_len = 0;
6291 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6292 const mbedtls_md_info_t *md_info;
6293 mbedtls_md_context_t md_ctx;
6294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6295
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6299 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6300 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 tmp_len = md_len + strlen(label) + rlen;
6305 tmp = mbedtls_calloc(1, tmp_len);
6306 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006307 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6308 goto exit;
6309 }
6310
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 nb = strlen(label);
6312 memcpy(tmp + md_len, label, nb);
6313 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006314 nb += rlen;
6315
6316 /*
6317 * Compute P_<hash>(secret, label + random)[0..dlen]
6318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006320 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6324 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006325 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 }
6327 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6328 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006329 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 }
6331 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6332 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006333 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 for (i = 0; i < dlen; i += md_len) {
6337 ret = mbedtls_md_hmac_reset(&md_ctx);
6338 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006339 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 }
6341 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6342 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 }
6345 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6346 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006347 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 ret = mbedtls_md_hmac_reset(&md_ctx);
6351 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006352 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 }
6354 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6355 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006356 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 }
6358 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6359 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006360 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006364
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006366 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006368 }
6369
6370exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006372
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (tmp != NULL) {
6374 mbedtls_platform_zeroize(tmp, tmp_len);
6375 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006376
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006382}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006383#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006384#endif /* MBEDTLS_USE_PSA_CRYPTO */
6385
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006386#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006388static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6389 const char *label,
6390 const unsigned char *random, size_t rlen,
6391 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006392{
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6394 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006395}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006396#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006397
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006398#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006400static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6401 const char *label,
6402 const unsigned char *random, size_t rlen,
6403 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006404{
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6406 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006407}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006408#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006409
Jerry Yuf009d862022-02-17 14:01:37 +08006410/*
6411 * Set appropriate PRF function and other SSL / TLS1.2 functions
6412 *
6413 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006414 * - hash associated with the ciphersuite (only used by TLS 1.2)
6415 *
6416 * Outputs:
6417 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6418 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006419MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006420static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6421 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006422{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006425 handshake->tls_prf = tls_prf_sha384;
6426 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6427 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006429#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006430#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006431 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006432 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006433 handshake->tls_prf = tls_prf_sha256;
6434 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6435 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6436 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006437#else
Jerry Yuf009d862022-02-17 14:01:37 +08006438 {
Jerry Yuf009d862022-02-17 14:01:37 +08006439 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006440 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006442 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006443#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006444
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006446}
Jerry Yud6ab2352022-02-17 14:03:43 +08006447
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448/*
6449 * Compute master secret if needed
6450 *
6451 * Parameters:
6452 * [in/out] handshake
6453 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6454 * (PSA-PSK) ciphersuite_info, psk_opaque
6455 * [out] premaster (cleared)
6456 * [out] master
6457 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6458 * debug: conf->f_dbg, conf->p_dbg
6459 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006460 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006462MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006463static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6464 unsigned char *master,
6465 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466{
6467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6468
6469 /* cf. RFC 5246, Section 8.1:
6470 * "The master secret is always exactly 48 bytes in length." */
6471 size_t const master_secret_len = 48;
6472
6473#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6474 unsigned char session_hash[48];
6475#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6476
6477 /* The label for the KDF used for key expansion.
6478 * This is either "master secret" or "extended master secret"
6479 * depending on whether the Extended Master Secret extension
6480 * is used. */
6481 char const *lbl = "master secret";
6482
Przemek Stekielae4ed302022-04-05 17:15:55 +02006483 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484 * - If the Extended Master Secret extension is not used,
6485 * this is ClientHello.Random + ServerHello.Random
6486 * (see Sect. 8.1 in RFC 5246).
6487 * - If the Extended Master Secret extension is used,
6488 * this is the transcript of the handshake so far.
6489 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006490 unsigned char const *seed = handshake->randbytes;
6491 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006492
6493#if !defined(MBEDTLS_DEBUG_C) && \
6494 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6495 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006497 ssl = NULL; /* make sure we don't use it except for those cases */
6498 (void) ssl;
6499#endif
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 if (handshake->resume != 0) {
6502 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6503 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006504 }
6505
6506#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006508 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006509 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006510 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6511 if (ret != 0) {
6512 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6513 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006514
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6516 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006517 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006518#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006519
Przemek Stekiel99114f32022-04-22 11:20:09 +02006520#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006521 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523 /* Perform PSK-to-MS expansion in a single step. */
6524 psa_status_t status;
6525 psa_algorithm_t alg;
6526 mbedtls_svc_key_id_t psk;
6527 psa_key_derivation_operation_t derivation =
6528 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006529 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006536 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006538 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006540
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006541 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006545 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006546 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006547 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006548 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006549 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006550 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006551 other_secret_len = 48;
6552 other_secret = handshake->premaster + 2;
6553 break;
6554 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006555 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006556 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6557 other_secret = handshake->premaster + 2;
6558 break;
6559 default:
6560 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006561 }
6562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 status = setup_psa_key_derivation(&derivation, psk, alg,
6564 ssl->conf->psk, ssl->conf->psk_len,
6565 seed, seed_len,
6566 (unsigned char const *) lbl,
6567 (size_t) strlen(lbl),
6568 other_secret, other_secret_len,
6569 master_secret_len);
6570 if (status != PSA_SUCCESS) {
6571 psa_key_derivation_abort(&derivation);
6572 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006573 }
6574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 status = psa_key_derivation_output_bytes(&derivation,
6576 master,
6577 master_secret_len);
6578 if (status != PSA_SUCCESS) {
6579 psa_key_derivation_abort(&derivation);
6580 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006581 }
6582
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 status = psa_key_derivation_abort(&derivation);
6584 if (status != PSA_SUCCESS) {
6585 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6586 }
6587 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006588#endif
6589 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006590#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6592 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006593 psa_status_t status;
6594 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6595 psa_key_derivation_operation_t derivation =
6596 PSA_KEY_DERIVATION_OPERATION_INIT;
6597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006599
6600 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6601
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 status = psa_key_derivation_setup(&derivation, alg);
6603 if (status != PSA_SUCCESS) {
6604 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006605 }
6606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 status = psa_key_derivation_set_capacity(&derivation,
6608 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6609 if (status != PSA_SUCCESS) {
6610 psa_key_derivation_abort(&derivation);
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_pake_get_implicit_key(&handshake->psa_pake_ctx,
6615 &derivation);
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_key_derivation_output_bytes(&derivation,
6622 handshake->premaster,
6623 handshake->pmslen);
6624 if (status != PSA_SUCCESS) {
6625 psa_key_derivation_abort(&derivation);
6626 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6627 }
6628
6629 status = psa_key_derivation_abort(&derivation);
6630 if (status != PSA_SUCCESS) {
6631 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006632 }
6633 }
6634#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6636 lbl, seed, seed_len,
6637 master,
6638 master_secret_len);
6639 if (ret != 0) {
6640 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6641 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006642 }
6643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6645 handshake->premaster,
6646 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 mbedtls_platform_zeroize(handshake->premaster,
6649 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006650 }
6651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006653}
6654
Gilles Peskine449bd832023-01-11 14:50:10 +01006655int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006656{
6657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6658 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6659 ssl->handshake->ciphersuite_info;
6660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006662
6663 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006665 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 if (ret != 0) {
6667 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6668 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006669 }
6670
6671 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 ret = ssl_compute_master(ssl->handshake,
6673 ssl->session_negotiate->master,
6674 ssl);
6675 if (ret != 0) {
6676 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6677 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006678 }
6679
6680 /* Swap the client and server random values:
6681 * - MS derivation wanted client+server (RFC 5246 8.1)
6682 * - key derivation wants server+client (RFC 5246 6.3) */
6683 {
6684 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 memcpy(tmp, ssl->handshake->randbytes, 64);
6686 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6687 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6688 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006689 }
6690
6691 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6693 ssl->session_negotiate->ciphersuite,
6694 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006695#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006697#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 ssl->handshake->tls_prf,
6699 ssl->handshake->randbytes,
6700 ssl->tls_version,
6701 ssl->conf->endpoint,
6702 ssl);
6703 if (ret != 0) {
6704 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6705 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006706 }
6707
6708 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6710 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006715}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006718{
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006720#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006721 case MBEDTLS_SSL_HASH_SHA384:
6722 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6723 break;
6724#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006725#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006726 case MBEDTLS_SSL_HASH_SHA256:
6727 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6728 break;
6729#endif
6730 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006732 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006733#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6734 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006735 (void) ssl;
6736#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006738}
6739
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006740#if defined(MBEDTLS_USE_PSA_CRYPTO)
6741static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6742 const psa_hash_operation_t *hs_op,
6743 size_t buffer_size,
6744 unsigned char *hash,
6745 size_t *hlen)
6746{
6747 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006748 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006749
6750#if !defined(MBEDTLS_DEBUG_C)
6751 (void) ssl;
6752#endif
6753 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006754 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006755 if (status != PSA_SUCCESS) {
6756 goto exit;
6757 }
6758
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006759 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006760 if (status != PSA_SUCCESS) {
6761 goto exit;
6762 }
6763
6764 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6765 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6766
6767exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006768 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006769 return mbedtls_md_error_from_psa(status);
6770}
6771#else
6772static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6773 const mbedtls_md_context_t *hs_ctx,
6774 unsigned char *hash,
6775 size_t *hlen)
6776{
6777 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006778 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006779
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006780 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006781
6782#if !defined(MBEDTLS_DEBUG_C)
6783 (void) ssl;
6784#endif
6785 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6786
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006787 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006788 if (ret != 0) {
6789 goto exit;
6790 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006791 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006792 if (ret != 0) {
6793 goto exit;
6794 }
6795
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006796 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006797 if (ret != 0) {
6798 goto exit;
6799 }
6800
6801 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6802
6803 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6804 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6805
6806exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006807 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006808 return ret;
6809}
6810#endif /* MBEDTLS_USE_PSA_CRYPTO */
6811
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006812#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006813int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6814 unsigned char *hash,
6815 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006816{
6817#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006818 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6819 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006820#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006821 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6822 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006823#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006824}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006825#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006826
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006827#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006828int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6829 unsigned char *hash,
6830 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006831{
6832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006833 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6834 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006835#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006836 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6837 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006838#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006839}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006840#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006841
Neil Armstrong80f6f322022-05-03 17:56:38 +02006842#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6843 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006844int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006845{
6846 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 const unsigned char *psk = NULL;
6849 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006853 /*
6854 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006855 * checked before calling this function.
6856 *
6857 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006858 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6861 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6862 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006863 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006864 }
6865
6866 /*
6867 * PMS = struct {
6868 * opaque other_secret<0..2^16-1>;
6869 * opaque psk<0..2^16-1>;
6870 * };
6871 * with "other_secret" depending on the particular key exchange
6872 */
6873#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6875 if (end - p < 2) {
6876 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6877 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006880 p += 2;
6881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 if (end < p || (size_t) (end - p) < psk_len) {
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 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006887 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006889#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6890#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006892 /*
6893 * other_secret already set by the ClientKeyExchange message,
6894 * and is 48 bytes long
6895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (end - p < 2) {
6897 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6898 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006899
6900 *p++ = 0;
6901 *p++ = 48;
6902 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006904#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6905#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006907 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6908 size_t len;
6909
6910 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006912 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6914 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6915 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006916 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006918 p += 2 + len;
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6921 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006922#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006923#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6926 size_t zlen;
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006929 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6931 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6932 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006933 }
6934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006936 p += 2 + zlen;
6937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6939 MBEDTLS_DEBUG_ECDH_Z);
6940 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006941#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006942 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6944 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006945 }
6946
6947 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (end - p < 2) {
6949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6950 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006951
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006953 p += 2;
6954
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (end < p || (size_t) (end - p) < psk_len) {
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 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006960 p += psk_len;
6961
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006962 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006965}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006966#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006967
6968#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006969MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006970static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006971
6972#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006973int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006974{
6975 /* If renegotiation is not enforced, retransmit until we would reach max
6976 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006978 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6979 unsigned char doublings = 1;
6980
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006982 ++doublings;
6983 ratio >>= 1;
6984 }
6985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 if (++ssl->renego_records_seen > doublings) {
6987 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6988 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006989 }
6990 }
6991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006993}
6994#endif
6995#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006996
Jerry Yud9526692022-02-17 14:23:47 +08006997/*
6998 * Handshake functions
6999 */
7000#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7001/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007002int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007003{
7004 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7005 ssl->handshake->ciphersuite_info;
7006
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7010 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007011 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007013 }
7014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7016 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007017}
7018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007020{
7021 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7022 ssl->handshake->ciphersuite_info;
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7027 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007028 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007030 }
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7033 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007034}
7035
7036#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7037/* Some certificate support -> implement write and parse */
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007040{
7041 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7042 size_t i, n;
7043 const mbedtls_x509_crt *crt;
7044 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7045 ssl->handshake->ciphersuite_info;
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7050 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007051 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007053 }
7054
7055#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7057 if (ssl->handshake->client_auth == 0) {
7058 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007059 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007061 }
7062 }
7063#endif /* MBEDTLS_SSL_CLI_C */
7064#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7066 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007067 /* Should never happen because we shouldn't have picked the
7068 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007070 }
7071 }
7072#endif
7073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007075
7076 /*
7077 * 0 . 0 handshake type
7078 * 1 . 3 handshake length
7079 * 4 . 6 length of all certs
7080 * 7 . 9 length of cert. 1
7081 * 10 . n-1 peer certificate
7082 * n . n+2 length of cert. 2
7083 * n+3 . ... upper level cert, etc.
7084 */
7085 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007089 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7091 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7092 " > %" MBEDTLS_PRINTF_SIZET,
7093 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7094 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007095 }
7096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7098 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7099 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007102 i += n; crt = crt->next;
7103 }
7104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7106 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7107 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007108
7109 ssl->out_msglen = i;
7110 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7111 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7112
7113 ssl->state++;
7114
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7116 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7117 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007118 }
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007123}
7124
7125#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7126
7127#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007129static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7130 unsigned char *crt_buf,
7131 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007132{
7133 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 if (peer_crt == NULL) {
7136 return -1;
7137 }
Jerry Yud9526692022-02-17 14:23:47 +08007138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (peer_crt->raw.len != crt_buf_len) {
7140 return -1;
7141 }
Jerry Yud9526692022-02-17 14:23:47 +08007142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007144}
7145#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007147static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7148 unsigned char *crt_buf,
7149 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007150{
7151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7152 unsigned char const * const peer_cert_digest =
7153 ssl->session->peer_cert_digest;
7154 mbedtls_md_type_t const peer_cert_digest_type =
7155 ssl->session->peer_cert_digest_type;
7156 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007158 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7159 size_t digest_len;
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 if (peer_cert_digest == NULL || digest_info == NULL) {
7162 return -1;
7163 }
Jerry Yud9526692022-02-17 14:23:47 +08007164
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 digest_len = mbedtls_md_get_size(digest_info);
7166 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7167 return -1;
7168 }
Jerry Yud9526692022-02-17 14:23:47 +08007169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7171 if (ret != 0) {
7172 return -1;
7173 }
Jerry Yud9526692022-02-17 14:23:47 +08007174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007176}
7177#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7178#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7179
7180/*
7181 * Once the certificate message is read, parse it into a cert chain and
7182 * perform basic checks, but leave actual verification to the caller
7183 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007184MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007185static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7186 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007187{
7188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7189#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007191#endif
7192 size_t i, n;
7193 uint8_t alert;
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7196 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7197 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7198 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7199 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007200 }
7201
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7203 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7204 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7205 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007206 }
7207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7209 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7210 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7211 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7212 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007213 }
7214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007216
7217 /*
7218 * Same message structure as in mbedtls_ssl_write_certificate()
7219 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007220 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007221
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 if (ssl->in_msg[i] != 0 ||
7223 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7224 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7225 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7226 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7227 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007228 }
7229
7230 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7231 i += 3;
7232
7233 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007235 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 if (i + 3 > ssl->in_hslen) {
7237 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7238 mbedtls_ssl_send_alert_message(ssl,
7239 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7240 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7241 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007242 }
7243 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7244 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 if (ssl->in_msg[i] != 0) {
7246 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7247 mbedtls_ssl_send_alert_message(ssl,
7248 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7249 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7250 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007251 }
7252
7253 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007254 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007255 i += 3;
7256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 if (n < 128 || i + n > ssl->in_hslen) {
7258 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7259 mbedtls_ssl_send_alert_message(ssl,
7260 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7261 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7262 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007263 }
7264
7265 /* Check if we're handling the first CRT in the chain. */
7266#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007268 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007270 /* During client-side renegotiation, check that the server's
7271 * end-CRTs hasn't changed compared to the initial handshake,
7272 * mitigating the triple handshake attack. On success, reuse
7273 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7275 if (ssl_check_peer_crt_unchanged(ssl,
7276 &ssl->in_msg[i],
7277 n) != 0) {
7278 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7279 mbedtls_ssl_send_alert_message(ssl,
7280 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7281 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7282 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007283 }
7284
7285 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007287 }
7288#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7289
7290 /* Parse the next certificate in the chain. */
7291#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007293#else
7294 /* If we don't need to store the CRT chain permanently, parse
7295 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007297#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007299 case 0: /*ok*/
7300 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7301 /* Ignore certificate with an unknown algorithm: maybe a
7302 prior certificate was already trusted. */
7303 break;
7304
7305 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7306 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7307 goto crt_parse_der_failed;
7308
7309 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7310 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7311 goto crt_parse_der_failed;
7312
7313 default:
7314 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007315crt_parse_der_failed:
7316 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7317 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7318 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007319 }
7320
7321 i += n;
7322 }
7323
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7325 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007326}
7327
7328#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007329MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007330static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007331{
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7333 return -1;
7334 }
Jerry Yud9526692022-02-17 14:23:47 +08007335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007337 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7338 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7340 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7341 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007342 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007344}
7345#endif /* MBEDTLS_SSL_SRV_C */
7346
7347/* Check if a certificate message is expected.
7348 * Return either
7349 * - SSL_CERTIFICATE_EXPECTED, or
7350 * - SSL_CERTIFICATE_SKIP
7351 * indicating whether a Certificate message is expected or not.
7352 */
7353#define SSL_CERTIFICATE_EXPECTED 0
7354#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007355MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007356static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7357 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007358{
7359 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7360 ssl->handshake->ciphersuite_info;
7361
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7363 return SSL_CERTIFICATE_SKIP;
7364 }
Jerry Yud9526692022-02-17 14:23:47 +08007365
7366#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7368 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7369 return SSL_CERTIFICATE_SKIP;
7370 }
Jerry Yud9526692022-02-17 14:23:47 +08007371
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007373 ssl->session_negotiate->verify_result =
7374 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007376 }
7377 }
7378#else
7379 ((void) authmode);
7380#endif /* MBEDTLS_SSL_SRV_C */
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007383}
7384
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007385MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007386static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7387 int authmode,
7388 mbedtls_x509_crt *chain,
7389 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007390{
7391 int ret = 0;
7392 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7393 ssl->handshake->ciphersuite_info;
7394 int have_ca_chain = 0;
7395
7396 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7397 void *p_vrfy;
7398
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7400 return 0;
7401 }
Jerry Yud9526692022-02-17 14:23:47 +08007402
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (ssl->f_vrfy != NULL) {
7404 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007405 f_vrfy = ssl->f_vrfy;
7406 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 } else {
7408 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007409 f_vrfy = ssl->conf->f_vrfy;
7410 p_vrfy = ssl->conf->p_vrfy;
7411 }
7412
7413 /*
7414 * Main check: verify certificate
7415 */
7416#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007418 ((void) rs_ctx);
7419 have_ca_chain = 1;
7420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007422 ret = mbedtls_x509_crt_verify_with_ca_cb(
7423 chain,
7424 ssl->conf->f_ca_cb,
7425 ssl->conf->p_ca_cb,
7426 ssl->conf->cert_profile,
7427 ssl->hostname,
7428 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 f_vrfy, p_vrfy);
7430 } else
Jerry Yud9526692022-02-17 14:23:47 +08007431#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7432 {
7433 mbedtls_x509_crt *ca_chain;
7434 mbedtls_x509_crl *ca_crl;
7435
7436#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 ca_chain = ssl->handshake->sni_ca_chain;
7439 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 } else
Jerry Yud9526692022-02-17 14:23:47 +08007441#endif
7442 {
7443 ca_chain = ssl->conf->ca_chain;
7444 ca_crl = ssl->conf->ca_crl;
7445 }
7446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007448 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 }
Jerry Yud9526692022-02-17 14:23:47 +08007450
7451 ret = mbedtls_x509_crt_verify_restartable(
7452 chain,
7453 ca_chain, ca_crl,
7454 ssl->conf->cert_profile,
7455 ssl->hostname,
7456 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007458 }
7459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (ret != 0) {
7461 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007462 }
7463
7464#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7466 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7467 }
Jerry Yud9526692022-02-17 14:23:47 +08007468#endif
7469
7470 /*
7471 * Secondary checks: always done, but change 'ret' only if it was 0
7472 */
7473
Valerio Settiacd32c02023-06-29 18:06:29 +02007474#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007475 {
7476 const mbedtls_pk_context *pk = &chain->pk;
7477
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007478 /* If certificate uses an EC key, make sure the curve is OK.
7479 * This is a public key, so it can't be opaque, so can_do() is a good
7480 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007482 /* and in the unlikely case the above assumption no longer holds
7483 * we are making sure that pk_ec() here does not return a NULL
7484 */
Valerio Settif9362b72023-11-29 08:42:27 +01007485 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007486 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7487 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007489 }
Valerio Setti97207782023-05-18 18:59:06 +02007490 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007491 ssl->session_negotiate->verify_result |=
7492 MBEDTLS_X509_BADCERT_BAD_KEY;
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7495 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007496 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007498 }
Jerry Yud9526692022-02-17 14:23:47 +08007499 }
7500 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007501#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007502
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (mbedtls_ssl_check_cert_usage(chain,
7504 ciphersuite_info,
7505 !ssl->conf->endpoint,
7506 &ssl->session_negotiate->verify_result) != 0) {
7507 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7508 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007509 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 }
Jerry Yud9526692022-02-17 14:23:47 +08007511 }
7512
7513 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7514 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7515 * with details encoded in the verification flags. All other kinds
7516 * of error codes, including those from the user provided f_vrfy
7517 * functions, are treated as fatal and lead to a failure of
7518 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7520 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7521 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007522 ret = 0;
7523 }
7524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7526 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007527 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7528 }
7529
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007531 uint8_t alert;
7532
7533 /* The certificate may have been rejected for several reasons.
7534 Pick one and send the corresponding alert. Which alert to send
7535 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007537 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007539 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007541 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007543 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007545 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007547 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007549 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007551 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007553 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007555 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007557 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 }
7559 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7560 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007561 }
7562
7563#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (ssl->session_negotiate->verify_result != 0) {
7565 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7566 (unsigned int) ssl->session_negotiate->verify_result));
7567 } else {
7568 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007569 }
7570#endif /* MBEDTLS_DEBUG_C */
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007573}
7574
7575#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007577static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7578 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007579{
7580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7581 /* Remember digest of the peer's end-CRT. */
7582 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7584 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7585 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7586 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7587 mbedtls_ssl_send_alert_message(ssl,
7588 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7589 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007592 }
7593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 ret = mbedtls_md(mbedtls_md_info_from_type(
7595 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7596 start, len,
7597 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007598
7599 ssl->session_negotiate->peer_cert_digest_type =
7600 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7601 ssl->session_negotiate->peer_cert_digest_len =
7602 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007605}
7606
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007607MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007608static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7609 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007610{
7611 unsigned char *end = start + len;
7612 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7613
7614 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7616 ret = mbedtls_pk_parse_subpubkey(&start, end,
7617 &ssl->handshake->peer_pubkey);
7618 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007619 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007621 }
7622
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007624}
7625#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007628{
7629 int ret = 0;
7630 int crt_expected;
7631#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7632 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7633 ? ssl->handshake->sni_authmode
7634 : ssl->conf->authmode;
7635#else
7636 const int authmode = ssl->conf->authmode;
7637#endif
7638 void *rs_ctx = NULL;
7639 mbedtls_x509_crt *chain = NULL;
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7644 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7645 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007646 goto exit;
7647 }
7648
7649#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 if (ssl->handshake->ecrs_enabled &&
7651 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007652 chain = ssl->handshake->ecrs_peer_cert;
7653 ssl->handshake->ecrs_peer_cert = NULL;
7654 goto crt_verify;
7655 }
7656#endif
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 /* mbedtls_ssl_read_record may have sent an alert already. We
7660 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007662 goto exit;
7663 }
7664
7665#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007667 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007670 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 }
Jerry Yud9526692022-02-17 14:23:47 +08007672
7673 goto exit;
7674 }
7675#endif /* MBEDTLS_SSL_SRV_C */
7676
7677 /* Clear existing peer CRT structure in case we tried to
7678 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007680
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7682 if (chain == NULL) {
7683 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7684 sizeof(mbedtls_x509_crt)));
7685 mbedtls_ssl_send_alert_message(ssl,
7686 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7687 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007688
7689 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7690 goto exit;
7691 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 ret = ssl_parse_certificate_chain(ssl, chain);
7695 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007696 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
7699#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007701 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 }
Jerry Yud9526692022-02-17 14:23:47 +08007703
7704crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007706 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 }
Jerry Yud9526692022-02-17 14:23:47 +08007708#endif
7709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 ret = ssl_parse_certificate_verify(ssl, authmode,
7711 chain, rs_ctx);
7712 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007713 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 }
Jerry Yud9526692022-02-17 14:23:47 +08007715
7716#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7717 {
7718 unsigned char *crt_start, *pk_start;
7719 size_t crt_len, pk_len;
7720
7721 /* We parse the CRT chain without copying, so
7722 * these pointers point into the input buffer,
7723 * and are hence still valid after freeing the
7724 * CRT chain. */
7725
7726 crt_start = chain->raw.p;
7727 crt_len = chain->raw.len;
7728
7729 pk_start = chain->pk_raw.p;
7730 pk_len = chain->pk_raw.len;
7731
7732 /* Free the CRT structures before computing
7733 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 mbedtls_x509_crt_free(chain);
7735 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007736 chain = NULL;
7737
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7739 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007740 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 }
Jerry Yud9526692022-02-17 14:23:47 +08007742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7744 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007745 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 }
Jerry Yud9526692022-02-17 14:23:47 +08007747 }
7748#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7749 /* Pass ownership to session structure. */
7750 ssl->session_negotiate->peer_cert = chain;
7751 chain = NULL;
7752#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007755
7756exit:
7757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007759 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 }
Jerry Yud9526692022-02-17 14:23:47 +08007761
7762#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007764 ssl->handshake->ecrs_peer_cert = chain;
7765 chain = NULL;
7766 }
7767#endif
7768
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 if (chain != NULL) {
7770 mbedtls_x509_crt_free(chain);
7771 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007772 }
7773
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007775}
7776#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7777
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007778static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7779 unsigned char *padbuf, size_t hlen,
7780 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007781{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007782 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007783 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007784#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007785 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007786 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007787 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007788 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007789#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007791 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007792 mbedtls_md_context_t cloned_ctx;
7793 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007794#endif
7795
7796 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007798 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007800
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007802 ? "client finished"
7803 : "server finished";
7804
7805#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007806 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007807
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007808 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007810 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007811 }
7812
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007813 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007815 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007816 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007817 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007818#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007819 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007820
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007821 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007822 if (ret != 0) {
7823 goto exit;
7824 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007825 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007826 if (ret != 0) {
7827 goto exit;
7828 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007829
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007830 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007831 if (ret != 0) {
7832 goto exit;
7833 }
7834#endif /* MBEDTLS_USE_PSA_CRYPTO */
7835
7836 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7837
Jerry Yu615bd6f2022-02-17 14:25:15 +08007838 /*
7839 * TLSv1.2:
7840 * hash = PRF( master, finished_label,
7841 * Hash( handshake ) )[0.11]
7842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007844 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007845
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007847
Paul Elliottecb95be2023-08-11 16:41:04 +01007848 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007849
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007850 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007851
7852exit:
7853#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007854 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007855 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007856#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007857 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007858 return ret;
7859#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007860}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007861
7862#if defined(MBEDTLS_MD_CAN_SHA256)
7863static int ssl_calc_finished_tls_sha256(
7864 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7865{
7866 unsigned char padbuf[32];
7867 return ssl_calc_finished_tls_generic(ssl,
7868#if defined(MBEDTLS_USE_PSA_CRYPTO)
7869 &ssl->handshake->fin_sha256_psa,
7870#else
7871 &ssl->handshake->fin_sha256,
7872#endif
7873 padbuf, sizeof(padbuf),
7874 buf, from);
7875}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007876#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007877
Jerry Yub7ba49e2022-02-17 14:25:53 +08007878
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007879#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007880static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007882{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007883 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007884 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007885#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007886 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007887#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007888 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007889#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007890 padbuf, sizeof(padbuf),
7891 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007892}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007893#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007894
Gilles Peskine449bd832023-01-11 14:50:10 +01007895void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007896{
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007898
7899 /*
7900 * Free our handshake params
7901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 mbedtls_ssl_handshake_free(ssl);
7903 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007904 ssl->handshake = NULL;
7905
7906 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007907 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (ssl->transform) {
7910 mbedtls_ssl_transform_free(ssl->transform);
7911 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007912 }
7913 ssl->transform = ssl->transform_negotiate;
7914 ssl->transform_negotiate = NULL;
7915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007917}
7918
Gilles Peskine449bd832023-01-11 14:50:10 +01007919void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007920{
7921 int resume = ssl->handshake->resume;
7922
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007924
7925#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7928 ssl->renego_records_seen = 0;
7929 }
7930#endif
7931
7932 /*
7933 * Free the previous session and switch in the current one
7934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007936#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7937 /* RFC 7366 3.1: keep the EtM state */
7938 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007940#endif
7941
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 mbedtls_ssl_session_free(ssl->session);
7943 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007944 }
7945 ssl->session = ssl->session_negotiate;
7946 ssl->session_negotiate = NULL;
7947
7948 /*
7949 * Add cache entry
7950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007952 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 resume == 0) {
7954 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7955 ssl->session->id,
7956 ssl->session->id_len,
7957 ssl->session) != 0) {
7958 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7959 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007960 }
7961
7962#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7964 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007965 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007967
7968 /* Keep last flight around in case we need to resend it:
7969 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7971 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007972#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007974
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007975 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007976
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007978}
7979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007981{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007982 int ret;
7983 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007988
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007989 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7990 if (ret != 0) {
7991 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7992 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993
7994 /*
7995 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7996 * may define some other value. Currently (early 2016), no defined
7997 * ciphersuite does this (and this is unlikely to change as activity has
7998 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7999 */
8000 hash_len = 12;
8001
8002#if defined(MBEDTLS_SSL_RENEGOTIATION)
8003 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008005#endif
8006
8007 ssl->out_msglen = 4 + hash_len;
8008 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8009 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8010
8011 /*
8012 * In case of session resuming, invert the client and server
8013 * ChangeCipherSpec messages order.
8014 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008020#endif
8021#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008023 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008025#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029
8030 /*
8031 * Switch to our negotiated transform and session parameters for outbound
8032 * data.
8033 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008035
8036#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038 unsigned char i;
8039
8040 /* Remember current epoch settings for resending */
8041 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8043 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008044
8045 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008047
8048
8049 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 for (i = 2; i > 0; i--) {
8051 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008052 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 }
8054 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008055
8056 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 if (i == 0) {
8058 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8059 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008060 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008062#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008064
8065 ssl->transform_out = ssl->transform_negotiate;
8066 ssl->session_out = ssl->session_negotiate;
8067
8068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8070 mbedtls_ssl_send_flight_completed(ssl);
8071 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008072#endif
8073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8075 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8076 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008077 }
8078
8079#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8081 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8082 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8083 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008084 }
8085#endif
8086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008090}
8091
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008092#define SSL_MAX_HASH_LEN 12
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008095{
8096 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8097 unsigned int hash_len = 12;
8098 unsigned char buf[SSL_MAX_HASH_LEN];
8099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008101
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008102 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8103 if (ret != 0) {
8104 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8105 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008106
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8108 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008109 goto exit;
8110 }
8111
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8113 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8114 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8115 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8117 goto exit;
8118 }
8119
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
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_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8128 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8129 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8130 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008131 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8132 goto exit;
8133 }
8134
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8136 buf, hash_len) != 0) {
8137 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8138 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8139 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008140 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8141 goto exit;
8142 }
8143
8144#if defined(MBEDTLS_SSL_RENEGOTIATION)
8145 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008147#endif
8148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008150#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008152 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008154#endif
8155#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008157 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008159#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008161 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008163
8164#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8166 mbedtls_ssl_recv_flight_completed(ssl);
8167 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008168#endif
8169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008171
8172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 mbedtls_platform_zeroize(buf, hash_len);
8174 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008175}
8176
Jerry Yu392112c2022-02-17 14:34:10 +08008177#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8178/*
8179 * Helper to get TLS 1.2 PRF from ciphersuite
8180 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008182static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008183{
Jerry Yu392112c2022-02-17 14:34:10 +08008184 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008186#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8188 return tls_prf_sha384;
8189 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008190#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008191#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008192 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8194 return tls_prf_sha256;
8195 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008196 }
8197#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008198#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8199 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008200 (void) ciphersuite_info;
8201#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008204}
8205#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008206
Gilles Peskine449bd832023-01-11 14:50:10 +01008207static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008208{
8209 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008210#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 if (tls_prf == tls_prf_sha384) {
8212 return MBEDTLS_SSL_TLS_PRF_SHA384;
8213 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008214#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008215#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 if (tls_prf == tls_prf_sha256) {
8217 return MBEDTLS_SSL_TLS_PRF_SHA256;
8218 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008219#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008221}
8222
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008223/*
8224 * Populate a transform structure with session keys and all the other
8225 * necessary information.
8226 *
8227 * Parameters:
8228 * - [in/out]: transform: structure to populate
8229 * [in] must be just initialised with mbedtls_ssl_transform_init()
8230 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8231 * - [in] ciphersuite
8232 * - [in] master
8233 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008234 * - [in] tls_prf: pointer to PRF to use for key derivation
8235 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008236 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008237 * - [in] endpoint: client or server
8238 * - [in] ssl: used for:
8239 * - ssl->conf->{f,p}_export_keys
8240 * [in] optionally used for:
8241 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8242 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008244static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8245 int ciphersuite,
8246 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008247#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008249#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 ssl_tls_prf_t tls_prf,
8251 const unsigned char randbytes[64],
8252 mbedtls_ssl_protocol_version tls_version,
8253 unsigned endpoint,
8254 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008255{
8256 int ret = 0;
8257 unsigned char keyblk[256];
8258 unsigned char *key1;
8259 unsigned char *key2;
8260 unsigned char *mac_enc;
8261 unsigned char *mac_dec;
8262 size_t mac_key_len = 0;
8263 size_t iv_copy_len;
8264 size_t keylen;
8265 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008266 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008267#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008268 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008270#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008271
8272#if defined(MBEDTLS_USE_PSA_CRYPTO)
8273 psa_key_type_t key_type;
8274 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8275 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008276 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277 size_t key_bits;
8278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8279#endif
8280
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008281 /*
8282 * Some data just needs copying into the structure
8283 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008284#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008286#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008287 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288
8289#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008291#endif
8292
8293#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008295 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8296 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008298 }
8299#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8300
8301 /*
8302 * Get various info structures
8303 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8305 if (ciphersuite_info == NULL) {
8306 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8307 ciphersuite));
8308 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008309 }
8310
Neil Armstrongab555e02022-04-04 11:07:59 +02008311 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008312#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008314#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008316
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008318 transform->taglen =
8319 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008321
8322#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008323 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 transform->taglen,
8325 &alg,
8326 &key_type,
8327 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008328 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008330 goto end;
8331 }
8332#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008333 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 if (cipher_info == NULL) {
8335 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8336 ciphersuite_info->cipher));
8337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008339#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008340
Neil Armstronge4512952022-03-08 09:08:22 +01008341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008342 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008344 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 (unsigned) ciphersuite_info->mac));
8346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008347 }
8348#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008349 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (md_info == NULL) {
8351 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8352 (unsigned) ciphersuite_info->mac));
8353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008354 }
Neil Armstronge4512952022-03-08 09:08:22 +01008355#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008356
8357#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8358 /* Copy own and peer's CID if the use of the CID
8359 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8361 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008362
8363 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8365 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8366 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008367
8368 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8370 ssl->handshake->peer_cid_len);
8371 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8372 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008373 }
8374#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8375
8376 /*
8377 * Compute key block using the PRF
8378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8380 if (ret != 0) {
8381 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8382 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383 }
8384
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8386 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8387 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8388 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8389 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390
8391 /*
8392 * Determine the appropriate key, IV and MAC length.
8393 */
8394
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008395#if defined(MBEDTLS_USE_PSA_CRYPTO)
8396 keylen = PSA_BITS_TO_BYTES(key_bits);
8397#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008399#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008400
Valerio Settie5707042023-10-11 11:54:42 +02008401#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 size_t explicit_ivlen;
8404
8405 transform->maclen = 0;
8406 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407
8408 /* All modes haves 96-bit IVs, but the length of the static parts vary
8409 * with mode and version:
8410 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8411 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8412 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8413 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8414 * sequence number).
8415 */
8416 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008417
8418 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008419#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008421#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8423 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008424#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008425
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008429 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008431
8432 /* Minimum length of encrypted record */
8433 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8434 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 } else
Valerio Settie5707042023-10-11 11:54:42 +02008436#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008439 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008441#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008443#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008444 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008445#endif /* MBEDTLS_USE_PSA_CRYPTO */
8446
8447#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008448 /* Get MAC length */
8449 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8450#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008451 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8453 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8454 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008455 goto end;
8456 }
8457
8458 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008460#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461 transform->maclen = mac_key_len;
8462
8463 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008466#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008467 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008468#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008469
8470 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474 /*
8475 * GenericBlockCipher:
8476 * 1. if EtM is in use: one block plus MAC
8477 * otherwise: * first multiple of blocklen greater than maclen
8478 * 2. IV
8479 */
8480#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008482 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 + block_size;
8484 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485#endif
8486 {
8487 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 + block_size
8489 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008490 }
8491
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008493 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 } else {
8495 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8497 goto end;
8498 }
8499 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008501#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8502 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8504 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505 }
8506
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8508 (unsigned) keylen,
8509 (unsigned) transform->minlen,
8510 (unsigned) transform->ivlen,
8511 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008512
8513 /*
8514 * Finally setup the cipher contexts, IVs and MAC secrets.
8515 */
8516#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008518 key1 = keyblk + mac_key_len * 2;
8519 key2 = keyblk + mac_key_len * 2 + keylen;
8520
8521 mac_enc = keyblk;
8522 mac_dec = keyblk + mac_key_len;
8523
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 iv_copy_len = (transform->fixed_ivlen) ?
8525 transform->fixed_ivlen : transform->ivlen;
8526 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8527 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8528 iv_copy_len);
8529 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008530#endif /* MBEDTLS_SSL_CLI_C */
8531#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008533 key1 = keyblk + mac_key_len * 2 + keylen;
8534 key2 = keyblk + mac_key_len * 2;
8535
8536 mac_enc = keyblk + mac_key_len;
8537 mac_dec = keyblk;
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 iv_copy_len = (transform->fixed_ivlen) ?
8540 transform->fixed_ivlen : transform->ivlen;
8541 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8542 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8543 iv_copy_len);
8544 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008545#endif /* MBEDTLS_SSL_SRV_C */
8546 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008548 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8549 goto end;
8550 }
8551
Paul Elliott4fb19552023-10-18 12:15:30 +01008552 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 ssl->f_export_keys(ssl->p_export_keys,
8554 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8555 master, 48,
8556 randbytes + 32,
8557 randbytes,
8558 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559 }
8560
8561#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008562 transform->psa_alg = alg;
8563
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8565 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8566 psa_set_key_algorithm(&attributes, alg);
8567 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 if ((status = psa_import_key(&attributes,
8570 key1,
8571 PSA_BITS_TO_BYTES(key_bits),
8572 &transform->psa_key_enc)) != PSA_SUCCESS) {
8573 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008574 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if ((status = psa_import_key(&attributes,
8582 key2,
8583 PSA_BITS_TO_BYTES(key_bits),
8584 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008585 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008587 goto end;
8588 }
8589 }
8590#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8592 cipher_info)) != 0) {
8593 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008594 goto end;
8595 }
8596
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8598 cipher_info)) != 0) {
8599 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008600 goto end;
8601 }
8602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8604 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8605 MBEDTLS_ENCRYPT)) != 0) {
8606 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", 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_dec, key2,
8611 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8612 MBEDTLS_DECRYPT)) != 0) {
8613 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008614 goto end;
8615 }
8616
8617#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8619 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8620 MBEDTLS_PADDING_NONE)) != 0) {
8621 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008622 goto end;
8623 }
8624
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8626 MBEDTLS_PADDING_NONE)) != 0) {
8627 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008628 goto end;
8629 }
8630 }
8631#endif /* MBEDTLS_CIPHER_MODE_CBC */
8632#endif /* MBEDTLS_USE_PSA_CRYPTO */
8633
Neil Armstrong29c0c042022-03-17 17:47:28 +01008634#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8635 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8636 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008638#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8642 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8643 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008644
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 if ((status = psa_import_key(&attributes,
8646 mac_enc, mac_key_len,
8647 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008648 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008650 goto end;
8651 }
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8654 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008657#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008659 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8661 PSA_KEY_USAGE_VERIFY_HASH);
8662 } else {
8663 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8664 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008665
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if ((status = psa_import_key(&attributes,
8667 mac_dec, mac_key_len,
8668 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008669 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008671 goto end;
8672 }
8673#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8675 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008676 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 }
8678 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8679 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008680 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008682#endif /* MBEDTLS_USE_PSA_CRYPTO */
8683 }
8684#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8685
8686 ((void) mac_dec);
8687 ((void) mac_enc);
8688
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008689end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8691 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008692}
8693
Valerio Settia08b1a42022-11-17 15:10:02 +01008694#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8695 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008696int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 psa_pake_operation_t *pake_ctx,
8698 const unsigned char *buf,
8699 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008700{
8701 psa_status_t status;
8702 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008703 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008704 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8705 * At round two perform a single cycle
8706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008708
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 for (; remaining_steps > 0; remaining_steps--) {
8710 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008711 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008713 /* Length is stored at the first byte */
8714 size_t length = buf[input_offset];
8715 input_offset += 1;
8716
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008718 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8719 }
8720
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 status = psa_pake_input(pake_ctx, step,
8722 buf + input_offset, length);
8723 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008724 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008725 }
8726
8727 input_offset += length;
8728 }
8729 }
8730
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008732 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008733 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008734
Gilles Peskine449bd832023-01-11 14:50:10 +01008735 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008736}
8737
Valerio Setti6b3dab02022-11-17 17:14:54 +01008738int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 psa_pake_operation_t *pake_ctx,
8740 unsigned char *buf,
8741 size_t len, size_t *olen,
8742 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008743{
8744 psa_status_t status;
8745 size_t output_offset = 0;
8746 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008747 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008748 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8749 * At round two perform a single cycle
8750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008752
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 for (; remaining_steps > 0; remaining_steps--) {
8754 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8755 step <= PSA_PAKE_STEP_ZK_PROOF;
8756 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008757 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008758 * For each step, prepend 1 byte with the length of the data as
8759 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 status = psa_pake_output(pake_ctx, step,
8762 buf + output_offset + 1,
8763 len - output_offset - 1,
8764 &output_len);
8765 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008766 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008767 }
8768
Valerio Setti99d88c12022-11-22 16:03:43 +01008769 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008770
8771 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008772 }
8773 }
8774
8775 *olen = output_offset;
8776
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008778}
Valerio Settia08b1a42022-11-17 15:10:02 +01008779#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8780
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008782int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8783 unsigned char *hash, size_t *hashlen,
8784 unsigned char *data, size_t data_len,
8785 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786{
8787 psa_status_t status;
8788 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008789 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008790
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008792
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 if ((status = psa_hash_setup(&hash_operation,
8794 hash_alg)) != PSA_SUCCESS) {
8795 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796 goto exit;
8797 }
8798
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8800 64)) != PSA_SUCCESS) {
8801 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008802 goto exit;
8803 }
8804
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 if ((status = psa_hash_update(&hash_operation,
8806 data, data_len)) != PSA_SUCCESS) {
8807 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008808 goto exit;
8809 }
8810
Gilles Peskine449bd832023-01-11 14:50:10 +01008811 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8812 hashlen)) != PSA_SUCCESS) {
8813 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8814 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008815 }
8816
8817exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 if (status != PSA_SUCCESS) {
8819 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8820 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8821 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008822 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008824 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8825 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008827 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008829 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008831 }
8832 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834}
8835
8836#else
8837
Gilles Peskine449bd832023-01-11 14:50:10 +01008838int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8839 unsigned char *hash, size_t *hashlen,
8840 unsigned char *data, size_t data_len,
8841 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008842{
8843 int ret = 0;
8844 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8846 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008847
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008851
8852 /*
8853 * digitally-signed struct {
8854 * opaque client_random[32];
8855 * opaque server_random[32];
8856 * ServerDHParams params;
8857 * };
8858 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8860 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008861 goto exit;
8862 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8864 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008865 goto exit;
8866 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8868 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008869 goto exit;
8870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8872 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008873 goto exit;
8874 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8876 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008877 goto exit;
8878 }
8879
8880exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008882
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 if (ret != 0) {
8884 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8885 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8886 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008887
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008889}
8890#endif /* MBEDTLS_USE_PSA_CRYPTO */
8891
Jerry Yud9d91da2022-02-17 14:57:06 +08008892#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8893
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008894/* Find the preferred hash for a given signature algorithm. */
8895unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 mbedtls_ssl_context *ssl,
8897 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008898{
Gabor Mezei078e8032022-04-27 21:17:56 +02008899 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008900 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8903 return MBEDTLS_SSL_HASH_NONE;
8904 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008905
Gilles Peskine449bd832023-01-11 14:50:10 +01008906 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008907 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8909 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008910 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8912 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008913
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008914 mbedtls_md_type_t md_alg =
8915 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8916 if (md_alg == MBEDTLS_MD_NONE) {
8917 continue;
8918 }
8919
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008921#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008923 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008924 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008925
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8927 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8928 PSA_ALG_ECDSA(psa_hash_alg),
8929 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008930 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008932
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8934 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8935 PSA_ALG_RSA_PKCS1V15_SIGN(
8936 psa_hash_alg),
8937 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008938 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008940 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008941#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008942
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008944 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008945 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008946
Gilles Peskine449bd832023-01-11 14:50:10 +01008947 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008948}
8949
8950#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8951
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008952/* Serialization of TLS 1.2 sessions:
8953 *
8954 * struct {
Ronald Crona93e25e2024-02-09 10:01:30 +01008955 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8956 * uint32 ticket_lifetime;
8957 * } ClientOnlyData;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008958 *
Ronald Crona93e25e2024-02-09 10:01:30 +01008959 * struct {
8960 * uint64 start_time;
8961 * uint8 session_id_len; // at most 32
8962 * opaque session_id[32];
8963 * opaque master[48]; // fixed length in the standard
8964 * uint32 verify_result;
8965 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8966 * select (endpoint) {
8967 * case client: ClientOnlyData;
8968 * case server: uint64 ticket_creation_time;
8969 * };
8970 * uint8 mfl_code; // up to 255 according to standard
8971 * uint8 encrypt_then_mac; // 0 or 1
8972 * } serialized_session_tls12;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008974static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8975 unsigned char *buf,
8976 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977{
8978 unsigned char *p = buf;
8979 size_t used = 0;
8980
8981#if defined(MBEDTLS_HAVE_TIME)
8982 uint64_t start;
8983#endif
8984#if defined(MBEDTLS_X509_CRT_PARSE_C)
8985#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8986 size_t cert_len;
8987#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8988#endif /* MBEDTLS_X509_CRT_PARSE_C */
8989
8990 /*
8991 * Time
8992 */
8993#if defined(MBEDTLS_HAVE_TIME)
8994 used += 8;
8995
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008997 start = (uint64_t) session->start;
8998
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000 p += 8;
9001 }
9002#endif /* MBEDTLS_HAVE_TIME */
9003
9004 /*
9005 * Basic mandatory fields
9006 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01009007 used += 1 /* id_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 + sizeof(session->id)
9009 + sizeof(session->master)
9010 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 if (used <= buf_len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 *p++ = MBEDTLS_BYTE_0(session->id_len);
9014 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009015 p += 32;
9016
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 p += 48;
9019
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009021 p += 4;
9022 }
9023
9024 /*
9025 * Peer's end-entity certificate
9026 */
9027#if defined(MBEDTLS_X509_CRT_PARSE_C)
9028#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009030 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009034
9035 used += 3 + cert_len;
9036
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 if (used <= buf_len) {
9038 *p++ = MBEDTLS_BYTE_2(cert_len);
9039 *p++ = MBEDTLS_BYTE_1(cert_len);
9040 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 if (session->peer_cert != NULL) {
9043 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 p += cert_len;
9045 }
9046 }
9047#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009051 *p++ = (unsigned char) session->peer_cert_digest_type;
9052 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 memcpy(p, session->peer_cert_digest,
9054 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055 p += session->peer_cert_digest_len;
9056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009058 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009060 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9061 *p++ = 0;
9062 }
9063 }
9064#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9065#endif /* MBEDTLS_X509_CRT_PARSE_C */
9066
9067 /*
9068 * Session ticket if any, plus associated data
9069 */
Ronald Cronc57f86e2023-11-22 09:50:01 +01009070#if defined(MBEDTLS_SSL_SESSION_TICKETS)
9071#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cronfeb577a2023-11-23 12:34:43 +01009072 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
9073 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074
Ronald Cronfeb577a2023-11-23 12:34:43 +01009075 if (used <= buf_len) {
9076 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9077 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9078 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009079
Ronald Cronfeb577a2023-11-23 12:34:43 +01009080 if (session->ticket != NULL) {
9081 memcpy(p, session->ticket, session->ticket_len);
9082 p += session->ticket_len;
9083 }
9084
9085 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
9086 p += 4;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009087 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088 }
Ronald Cronc57f86e2023-11-22 09:50:01 +01009089#endif /* MBEDTLS_SSL_CLI_C */
9090#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
9091 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
9092 used += 8;
9093
9094 if (used <= buf_len) {
9095 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
9096 p += 8;
9097 }
9098 }
9099#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
9100#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009101
9102 /*
9103 * Misc extension-related info
9104 */
9105#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9106 used += 1;
9107
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009109 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009111#endif
9112
9113#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9114 used += 1;
9115
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 if (used <= buf_len) {
9117 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9118 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119#endif
9120
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009122}
9123
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009124MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009125static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9126 const unsigned char *buf,
9127 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009128{
9129#if defined(MBEDTLS_HAVE_TIME)
9130 uint64_t start;
9131#endif
9132#if defined(MBEDTLS_X509_CRT_PARSE_C)
9133#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9134 size_t cert_len;
9135#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9136#endif /* MBEDTLS_X509_CRT_PARSE_C */
9137
9138 const unsigned char *p = buf;
9139 const unsigned char * const end = buf + len;
9140
9141 /*
9142 * Time
9143 */
9144#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 if (8 > (size_t) (end - p)) {
9146 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9147 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009149 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009150 p += 8;
9151
9152 session->start = (time_t) start;
9153#endif /* MBEDTLS_HAVE_TIME */
9154
9155 /*
9156 * Basic mandatory fields
9157 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01009158 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9160 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009161
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009162 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164 p += 32;
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009167 p += 48;
9168
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009169 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009170 p += 4;
9171
9172 /* Immediately clear invalid pointer values that have been read, in case
9173 * we exit early before we replaced them with valid ones. */
9174#if defined(MBEDTLS_X509_CRT_PARSE_C)
9175#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9176 session->peer_cert = NULL;
9177#else
9178 session->peer_cert_digest = NULL;
9179#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9180#endif /* MBEDTLS_X509_CRT_PARSE_C */
9181#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9182 session->ticket = NULL;
9183#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9184
9185 /*
9186 * Peer certificate
9187 */
9188#if defined(MBEDTLS_X509_CRT_PARSE_C)
9189#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9190 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 if (3 > (size_t) (end - p)) {
9192 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9193 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009194
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009195 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196 p += 3;
9197
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009199 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if (cert_len > (size_t) (end - p)) {
9202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9203 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 if (session->peer_cert == NULL) {
9208 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9209 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009210
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009212
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9214 p, cert_len)) != 0) {
9215 mbedtls_x509_crt_free(session->peer_cert);
9216 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009217 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219 }
9220
9221 p += cert_len;
9222 }
9223#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9224 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 if (2 > (size_t) (end - p)) {
9226 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9227 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009228
9229 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9230 session->peer_cert_digest_len = (size_t) *p++;
9231
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009233 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9235 if (md_info == NULL) {
9236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9237 }
9238 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9240 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009241
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9244 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009245
9246 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 mbedtls_calloc(1, session->peer_cert_digest_len);
9248 if (session->peer_cert_digest == NULL) {
9249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9250 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 memcpy(session->peer_cert_digest, p,
9253 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009254 p += session->peer_cert_digest_len;
9255 }
9256#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9257#endif /* MBEDTLS_X509_CRT_PARSE_C */
9258
9259 /*
9260 * Session ticket and associated data
9261 */
Ronald Cronc57f86e2023-11-22 09:50:01 +01009262#if defined(MBEDTLS_SSL_SESSION_TICKETS)
9263#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cronfeb577a2023-11-23 12:34:43 +01009264 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
9265 if (3 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9267 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009268
Ronald Cronfeb577a2023-11-23 12:34:43 +01009269 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
9270 p += 3;
9271
9272 if (session->ticket_len != 0) {
9273 if (session->ticket_len > (size_t) (end - p)) {
9274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9275 }
9276
9277 session->ticket = mbedtls_calloc(1, session->ticket_len);
9278 if (session->ticket == NULL) {
9279 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9280 }
9281
9282 memcpy(session->ticket, p, session->ticket_len);
9283 p += session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009284 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009285
Ronald Cronfeb577a2023-11-23 12:34:43 +01009286 if (4 > (size_t) (end - p)) {
9287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9288 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009289
Ronald Cronfeb577a2023-11-23 12:34:43 +01009290 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
9291 p += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 }
Ronald Cronc57f86e2023-11-22 09:50:01 +01009293#endif /* MBEDTLS_SSL_CLI_C */
9294#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
9295 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
9296 if (8 > (size_t) (end - p)) {
9297 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9298 }
9299 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
9300 p += 8;
9301 }
9302#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
9303#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009304
9305 /*
9306 * Misc extension-related info
9307 */
9308#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009309 if (1 > (size_t) (end - p)) {
9310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9311 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009312
9313 session->mfl_code = *p++;
9314#endif
9315
9316#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 if (1 > (size_t) (end - p)) {
9318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9319 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009320
9321 session->encrypt_then_mac = *p++;
9322#endif
9323
9324 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 if (p != end) {
9326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9327 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009328
Gilles Peskine449bd832023-01-11 14:50:10 +01009329 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009330}
Jerry Yudc7bd172022-02-17 13:44:15 +08009331#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9332
XiaokangQian75d40ef2022-04-20 11:05:24 +00009333int mbedtls_ssl_validate_ciphersuite(
9334 const mbedtls_ssl_context *ssl,
9335 const mbedtls_ssl_ciphersuite_t *suite_info,
9336 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009338{
9339 (void) ssl;
9340
Gilles Peskine449bd832023-01-11 14:50:10 +01009341 if (suite_info == NULL) {
9342 return -1;
9343 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009344
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 if ((suite_info->min_tls_version > max_tls_version) ||
9346 (suite_info->max_tls_version < min_tls_version)) {
9347 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009348 }
9349
XiaokangQian060d8672022-04-21 09:24:56 +00009350#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009351#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009352#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9354 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009355#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9357 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009358#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009359 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009361 }
9362#endif
9363
9364 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9365#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009366 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9367 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9368 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009369 }
9370#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9371#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9372
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009374}
9375
Ronald Crone68ab4f2022-10-05 12:46:29 +02009376#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009377/*
9378 * Function for writing a signature algorithm extension.
9379 *
9380 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9381 * value (TLS 1.3 RFC8446):
9382 * enum {
9383 * ....
9384 * ecdsa_secp256r1_sha256( 0x0403 ),
9385 * ecdsa_secp384r1_sha384( 0x0503 ),
9386 * ecdsa_secp521r1_sha512( 0x0603 ),
9387 * ....
9388 * } SignatureScheme;
9389 *
9390 * struct {
9391 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9392 * } SignatureSchemeList;
9393 *
9394 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9395 * value (TLS 1.2 RFC5246):
9396 * enum {
9397 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9398 * sha512(6), (255)
9399 * } HashAlgorithm;
9400 *
9401 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9402 * SignatureAlgorithm;
9403 *
9404 * struct {
9405 * HashAlgorithm hash;
9406 * SignatureAlgorithm signature;
9407 * } SignatureAndHashAlgorithm;
9408 *
9409 * SignatureAndHashAlgorithm
9410 * supported_signature_algorithms<2..2^16-2>;
9411 *
9412 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9413 * generalization of the TLS 1.2 signature algorithm extension.
9414 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9415 * `SignatureScheme` field of TLS 1.3
9416 *
9417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009418int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9419 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009420{
9421 unsigned char *p = buf;
9422 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9423 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9424
9425 *out_len = 0;
9426
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009428
9429 /* Check if we have space for header and length field:
9430 * - extension_type (2 bytes)
9431 * - extension_data_length (2 bytes)
9432 * - supported_signature_algorithms_length (2 bytes)
9433 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009435 p += 6;
9436
9437 /*
9438 * Write supported_signature_algorithms
9439 */
9440 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9442 if (sig_alg == NULL) {
9443 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9444 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9447 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9448 *sig_alg,
9449 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9450 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009451 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 }
9453 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9454 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009455 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9457 *sig_alg,
9458 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009459 }
9460
9461 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009462 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 if (supported_sig_alg_len == 0) {
9464 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9465 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009466 }
9467
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9469 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9470 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009471
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009472 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009473
9474#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009476#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009477
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009479}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009480#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009481
XiaokangQian40a35232022-05-07 09:02:40 +00009482#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009483/*
9484 * mbedtls_ssl_parse_server_name_ext
9485 *
9486 * Structure of server_name extension:
9487 *
9488 * enum {
9489 * host_name(0), (255)
9490 * } NameType;
9491 * opaque HostName<1..2^16-1>;
9492 *
9493 * struct {
9494 * NameType name_type;
9495 * select (name_type) {
9496 * case host_name: HostName;
9497 * } name;
9498 * } ServerName;
9499 * struct {
9500 * ServerName server_name_list<1..2^16-1>
9501 * } ServerNameList;
9502 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009503MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009504int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9505 const unsigned char *buf,
9506 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009507{
9508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9509 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009510 size_t server_name_list_len, hostname_len;
9511 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009512
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009514
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9516 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009517 p += 2;
9518
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009520 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 while (p < server_name_list_end) {
9522 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9523 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9524 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9525 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009526
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009528 /* sni_name is intended to be used only during the parsing of the
9529 * ClientHello message (it is reset to NULL before the end of
9530 * the message parsing). Thus it is ok to just point to the
9531 * reception buffer and not make a copy of it.
9532 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009533 ssl->handshake->sni_name = p + 3;
9534 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 if (ssl->conf->f_sni == NULL) {
9536 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009537 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9539 ssl, p + 3, hostname_len);
9540 if (ret != 0) {
9541 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9542 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9543 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9544 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9545 }
9546 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009547 }
9548
9549 p += hostname_len + 3;
9550 }
9551
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009553}
9554#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9555
XiaokangQianacb39922022-06-17 10:18:48 +00009556#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009558int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9559 const unsigned char *buf,
9560 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009561{
9562 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009563 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009564 const unsigned char *protocol_name_list;
9565 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009566 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009567
9568 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 if (ssl->conf->alpn_list == NULL) {
9570 return 0;
9571 }
XiaokangQianacb39922022-06-17 10:18:48 +00009572
9573 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009574 * RFC7301, section 3.1
9575 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009576 *
XiaokangQianc7403452022-06-23 03:24:12 +00009577 * struct {
9578 * ProtocolName protocol_name_list<2..2^16-1>
9579 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009580 */
9581
XiaokangQianc7403452022-06-23 03:24:12 +00009582 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009583 * protocol_name_list_len 2 bytes
9584 * protocol_name_len 1 bytes
9585 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009586 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009587 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009588
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009590 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009592 protocol_name_list = p;
9593 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009594
9595 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009597 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9599 protocol_name_len);
9600 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009601 MBEDTLS_SSL_PEND_FATAL_ALERT(
9602 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9604 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009605 }
9606
9607 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009608 }
9609
9610 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9612 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009613 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009614 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009615 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009616 if (protocol_name_len == alpn_len &&
9617 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009618 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009619 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009620 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009621
9622 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009623 }
9624 }
9625
XiaokangQian95d5f542022-06-24 02:29:26 +00009626 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009627 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009628 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9629 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9630 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009631}
9632
Gilles Peskine449bd832023-01-11 14:50:10 +01009633int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9634 unsigned char *buf,
9635 unsigned char *end,
9636 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009637{
9638 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009639 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009640 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009641
Gilles Peskine449bd832023-01-11 14:50:10 +01009642 if (ssl->alpn_chosen == NULL) {
9643 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009644 }
9645
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 protocol_name_len = strlen(ssl->alpn_chosen);
9647 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009648
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009650 /*
9651 * 0 . 1 ext identifier
9652 * 2 . 3 ext length
9653 * 4 . 5 protocol list length
9654 * 6 . 6 protocol name length
9655 * 7 . 7+n protocol name
9656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009657 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009658
XiaokangQian95d5f542022-06-24 02:29:26 +00009659 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009660
Gilles Peskine449bd832023-01-11 14:50:10 +01009661 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9662 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009663 /* Note: the length of the chosen protocol has been checked to be less
9664 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9665 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009667
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009669
9670#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009672#endif
9673
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009675}
9676#endif /* MBEDTLS_SSL_ALPN */
9677
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009678#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009679 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009680 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009681 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009682int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9683 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009684{
9685 /* Initialize to suppress unnecessary compiler warning */
9686 size_t hostname_len = 0;
9687
9688 /* Check if new hostname is valid before
9689 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009690 if (hostname != NULL) {
9691 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009692
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9695 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009696 }
9697
9698 /* Now it's clear that we will overwrite the old hostname,
9699 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009700 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009701 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009702 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009703 }
9704
9705 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009706 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009707 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009708 } else {
9709 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9710 if (session->hostname == NULL) {
9711 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9712 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009713
Gilles Peskine449bd832023-01-11 14:50:10 +01009714 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009715 }
9716
Gilles Peskine449bd832023-01-11 14:50:10 +01009717 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009718}
Xiaokang Qian03409292022-10-12 02:49:52 +00009719#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9720 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009721 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009722 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009724#endif /* MBEDTLS_SSL_TLS_C */