blob: 870f7d938833bcc482d76a1ffce3ebc0c769c887 [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
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int ssl_tls12_session_load(mbedtls_ssl_session *session,
437 const unsigned char *buf,
438 size_t len);
439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100443#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
451int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
452 const unsigned char *secret, size_t slen,
453 const char *label,
454 const unsigned char *random, size_t rlen,
455 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300456{
457 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462 case MBEDTLS_SSL_TLS_PRF_SHA384:
463 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
466#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 case MBEDTLS_SSL_TLS_PRF_SHA256:
468 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100470#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 default:
473 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 }
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477}
478
Jerry Yuc73c6182022-02-08 20:29:25 +0800479#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800481{
482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (session->peer_cert != NULL) {
484 mbedtls_x509_crt_free(session->peer_cert);
485 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800486 session->peer_cert = NULL;
487 }
488#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800492 session->peer_cert_digest = NULL;
493 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
494 session->peer_cert_digest_len = 0;
495 }
496#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
497}
498#endif /* MBEDTLS_X509_CRT_PARSE_C */
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800503 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800505
506 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
Jan Bruckner151f6422023-02-10 12:45:19 +0100581 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
582 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
583
Jerry Yu7a485c12022-10-31 13:08:18 +0800584 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590}
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800593{
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800595}
596
Jerry Yud25cab02022-10-31 12:48:30 +0800597#if defined(MBEDTLS_DEBUG_C)
598static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800599 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800600 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
601 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
602 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
603 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
604 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
605 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
606 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
607 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
608 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
609 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
610 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
611 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
612 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
613 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
614 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
615 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
616 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
617 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
618 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
619 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
621 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
622 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
623 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
624 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
625 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100626 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
627 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800628};
629
Chien Wong4e9683e2023-12-28 17:07:43 +0800630static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800631 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
632 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
633 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
634 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
637 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
638 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
639 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
640 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
641 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
642 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
643 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
644 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
645 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
647 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
648 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
649 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
650 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
651 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
653 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
654 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
656 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
657 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100658 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
659 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800660};
661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 return extension_name_table[
665 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800666}
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800671 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800673 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800687}
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
690 int level, const char *file, int line,
691 int hs_msg_type, unsigned int extension_type,
692 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
694 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 mbedtls_debug_print_msg(
697 ssl, level, file, line,
698 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 ssl_tls13_get_hs_msg_name(hs_msg_type),
700 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800701 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800703 return;
704 }
705
706 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
711 mbedtls_ssl_get_extension_name(extension_type), extension_type,
712 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800720}
721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
723 int level, const char *file, int line,
724 int hs_msg_type, uint32_t extensions_mask,
725 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800726{
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 for (unsigned i = 0;
729 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
730 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800731 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800732 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800734 }
735}
736
Pengyu Lvee455c02023-01-12 14:37:24 +0800737#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800738static const char *ticket_flag_name_table[] =
739{
740 [0] = "ALLOW_PSK_RESUMPTION",
741 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
742 [3] = "ALLOW_EARLY_DATA",
743};
744
Pengyu Lv4938a562023-01-16 11:28:49 +0800745void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748{
749 size_t i;
750
751 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800752 "print ticket_flags (0x%02x)", flags);
753
754 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800755
756 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800757 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800758 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
759 ticket_flag_name_table[i]);
760 }
761 }
762}
763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
764
Jerry Yud25cab02022-10-31 12:48:30 +0800765#endif /* MBEDTLS_DEBUG_C */
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
768 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769{
770 ((void) ciphersuite_info);
771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100772#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800776#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100777#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800779 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800781#endif
782 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 return;
785 }
786}
787
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100788int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100789 unsigned hs_type,
790 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100791{
792 unsigned char hs_hdr[4];
793
794 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
796 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
797 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
798 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 unsigned char const *msg,
806 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100808 int ret;
809 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100810 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100812 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814}
815
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100816int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800817{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100818#if defined(MBEDTLS_MD_CAN_SHA256) || \
819 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_status_t status;
822#else
823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
824#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100825#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800826 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100827#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100828#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
831 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200832 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 }
834 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
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 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800838#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100839 mbedtls_md_free(&ssl->handshake->fin_sha256);
840 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100841 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
842 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
843 0);
844 if (ret != 0) {
845 return ret;
846 }
847 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 if (ret != 0) {
849 return ret;
850 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800851#endif
852#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100853#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
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 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha384);
865 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100877 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800878}
879
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100881 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800882{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100883#if defined(MBEDTLS_MD_CAN_SHA256) || \
884 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 psa_status_t status;
887#else
888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
889#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100890#else /* SHA-256 or SHA-384 */
891 ((void) ssl);
892 (void) buf;
893 (void) len;
894#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100895#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
898 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200899 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800901#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100902 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 if (ret != 0) {
904 return ret;
905 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#endif
907#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100908#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
911 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200912 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800914#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100915 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 if (ret != 0) {
917 return ret;
918 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#endif
920#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100921 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800922}
923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100926 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800927{
928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200929 return mbedtls_md_error_from_psa(psa_hash_update(
930 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934}
935#endif
936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100937#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100939 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800940{
941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200942 return mbedtls_md_error_from_psa(psa_hash_update(
943 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100945 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#endif
947}
948#endif
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100954#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500957#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100958 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200959#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500963 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100965 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
969 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200974#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200975 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200978#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->psa_pake_ctx = psa_pake_operation_init();
981 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
982#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200985#if defined(MBEDTLS_SSL_CLI_C)
986 handshake->ecjpake_cache = NULL;
987 handshake->ecjpake_cache_len = 0;
988#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200989#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200990
Gilles Peskineeccd8882020-03-10 12:19:08 +0100991#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200993#endif
994
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
996 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
997#endif
Hanno Becker75173122019-02-06 16:18:31 +0000998
999#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1000 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001002#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006{
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001008
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001009#if defined(MBEDTLS_USE_PSA_CRYPTO)
1010 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1011 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1014 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001015#endif
1016
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_md_init(&transform->md_ctx_enc);
1023 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001024#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031}
1032
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001034static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001035{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1037
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl->transform_negotiate) {
1041 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1042 }
Jerry Yu2e199812022-12-01 18:57:19 +08001043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->session_negotiate) {
1045 mbedtls_ssl_session_free(ssl->session_negotiate);
1046 }
1047 if (ssl->handshake) {
1048 mbedtls_ssl_handshake_free(ssl);
1049 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001050
Jerry Yu2e199812022-12-01 18:57:19 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /*
1053 * Either the pointers are now NULL or cleared properly and can be freed.
1054 * Now allocate missing structures.
1055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate == NULL) {
1057 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if (ssl->session_negotiate == NULL) {
1062 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001063 }
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->handshake == NULL) {
1066 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001068#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1069 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1072 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001073#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001078 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl->session_negotiate == NULL) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001085
1086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089#endif
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->session_negotiate = NULL;
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001095 }
1096
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001097#if defined(MBEDTLS_SSL_EARLY_DATA)
1098#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron90e22332024-01-22 15:24:21 +01001099 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_UNKNOWN;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001100#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_SRV_C)
1102 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1103#endif
1104#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001105
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_ssl_session_init(ssl->session_negotiate);
1108 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001109
Jerry Yu2e199812022-12-01 18:57:19 +08001110#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001112#endif
1113
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001115 ret = mbedtls_ssl_reset_checksum(ssl);
1116 if (ret != 0) {
1117 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1118 return ret;
1119 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120
Jerry Yud0766ec2022-09-22 10:46:57 +08001121#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1122 defined(MBEDTLS_SSL_SRV_C) && \
1123 defined(MBEDTLS_SSL_SESSION_TICKETS)
1124 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#endif
1127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001130 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001140#endif
1141
Brett Warrene0edc842021-08-17 09:53:13 +01001142/*
1143 * curve_list is translated to IANA TLS group identifiers here because
1144 * mbedtls_ssl_conf_curves returns void and so can't return
1145 * any error codes.
1146 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001147#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001148#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1149 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001151 size_t length;
1152 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1153
Thomas Daubney850a0792023-05-22 12:05:03 +01001154 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
1157 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1159 if (group_list == NULL) {
1160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1161 }
Brett Warrene0edc842021-08-17 09:53:13 +01001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 curve_list[i]);
1166 if (tls_id == 0) {
1167 mbedtls_free(group_list);
1168 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001169 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001170 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001171 }
1172
1173 group_list[length] = 0;
1174
1175 ssl->handshake->group_list = group_list;
1176 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001178 ssl->handshake->group_list = ssl->conf->group_list;
1179 ssl->handshake->group_list_heap_allocated = 0;
1180 }
1181#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001182#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001183
Ronald Crone68ab4f2022-10-05 12:46:29 +02001184#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001185#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001186#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001187 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1188 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1190 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001191 const int *md;
1192 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001193 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001194 uint16_t *p;
1195
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001196 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1197 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1198 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1201 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001202 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001204#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001206#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001207
Jerry Yub476a442022-01-21 18:14:45 +08001208#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001210#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1212 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1213 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001214 }
1215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1221 sizeof(uint16_t));
1222 if (ssl->handshake->sig_algs == NULL) {
1223 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1224 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 p = (uint16_t *) ssl->handshake->sig_algs;
1227 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1228 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1229 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001232#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001235#endif
1236#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001238 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001239#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001241 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001242 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001244#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 ssl->handshake->sig_algs_heap_allocated = 0;
1247 }
Jerry Yucc539102022-06-27 16:27:35 +08001248#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001249#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001251}
1252
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001253#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001254/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001255MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001256static int ssl_cookie_write_dummy(void *ctx,
1257 unsigned char **p, unsigned char *end,
1258 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259{
1260 ((void) ctx);
1261 ((void) p);
1262 ((void) end);
1263 ((void) cli_id);
1264 ((void) cli_id_len);
1265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267}
1268
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001270static int ssl_cookie_check_dummy(void *ctx,
1271 const unsigned char *cookie, size_t cookie_len,
1272 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273{
1274 ((void) ctx);
1275 ((void) cookie);
1276 ((void) cookie_len);
1277 ((void) cli_id);
1278 ((void) cli_id_len);
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001281}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001282#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283
Paul Bakker5121ce52009-01-03 21:22:43 +00001284/*
1285 * Initialize an SSL context
1286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001288{
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001290}
1291
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001293static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001294{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001295 const mbedtls_ssl_config *conf = ssl->conf;
1296
Ronald Cron6f135e12021-12-08 16:57:54 +01001297#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1299 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001302 }
1303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1305 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001306 }
1307#endif
1308
1309#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1311 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1312 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001313 }
1314#endif
1315
Ronald Cron6f135e12021-12-08 16:57:54 +01001316#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1318 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1319 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1320 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001321 }
1322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1324 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001325 }
1326#endif
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1329 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001330}
1331
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001332MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001333static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1334{
1335 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 ret = ssl_conf_version_check(ssl);
1337 if (ret != 0) {
1338 return ret;
1339 }
Jerry Yu60835a82021-08-04 10:13:52 +08001340
Jerry Yudef7ae42022-10-30 14:13:19 +08001341#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1342 /* RFC 8446 section 4.4.3
1343 *
1344 * If the verification fails, the receiver MUST terminate the handshake with
1345 * a "decrypt_error" alert.
1346 *
1347 * If the client is configured as TLS 1.3 only with optional verify, return
1348 * bad config.
1349 *
1350 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001351 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001353 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1354 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1355 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001357 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 1, ("Optional verify auth mode "
1359 "is not available for TLS 1.3 client"));
1360 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001361 }
1362#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1363
Jerry Yu60835a82021-08-04 10:13:52 +08001364 /* Space for further checks */
1365
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001367}
1368
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001369/*
1370 * Setup an SSL context
1371 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1374 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001375{
Janos Follath865b3eb2019-12-16 11:46:15 +00001376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001377 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1378 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001379
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001380 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if ((ret = ssl_conf_check(ssl)) != 0) {
1383 return ret;
1384 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001385 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001386
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001388 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001389 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001390
1391 /* Set to NULL in case of an error condition */
1392 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001393
Darryl Greenb33cc762019-11-28 14:29:44 +00001394#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1395 ssl->in_buf_len = in_buf_len;
1396#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1398 if (ssl->in_buf == NULL) {
1399 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001400 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001401 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001402 }
1403
Darryl Greenb33cc762019-11-28 14:29:44 +00001404#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1405 ssl->out_buf_len = out_buf_len;
1406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1408 if (ssl->out_buf == NULL) {
1409 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001410 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001411 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001412 }
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001415
Johan Pascalb62bb512015-12-03 21:56:45 +01001416#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001418#endif
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001421 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001425
1426error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 mbedtls_free(ssl->in_buf);
1428 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001429
1430 ssl->conf = NULL;
1431
Darryl Greenb33cc762019-11-28 14:29:44 +00001432#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1433 ssl->in_buf_len = 0;
1434 ssl->out_buf_len = 0;
1435#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001436 ssl->in_buf = NULL;
1437 ssl->out_buf = NULL;
1438
1439 ssl->in_hdr = NULL;
1440 ssl->in_ctr = NULL;
1441 ssl->in_len = NULL;
1442 ssl->in_iv = NULL;
1443 ssl->in_msg = NULL;
1444
1445 ssl->out_hdr = NULL;
1446 ssl->out_ctr = NULL;
1447 ssl->out_len = NULL;
1448 ssl->out_iv = NULL;
1449 ssl->out_msg = NULL;
1450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001452}
1453
1454/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001455 * Reset an initialized and used SSL context for re-use while retaining
1456 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001457 *
1458 * If partial is non-zero, keep data in the input buffer and client ID.
1459 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1462 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001463{
Darryl Greenb33cc762019-11-28 14:29:44 +00001464#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1465 size_t in_buf_len = ssl->in_buf_len;
1466 size_t out_buf_len = ssl->out_buf_len;
1467#else
1468 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1469 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1470#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001471
Hanno Beckerb0302c42021-08-03 09:39:42 +01001472#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1473 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001474#endif
1475
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001476 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001480
1481 /* Reset incoming message parsing */
1482 ssl->in_offt = NULL;
1483 ssl->nb_zero = 0;
1484 ssl->in_msgtype = 0;
1485 ssl->in_msglen = 0;
1486 ssl->in_hslen = 0;
1487 ssl->keep_current_message = 0;
1488 ssl->transform_in = NULL;
1489
1490#if defined(MBEDTLS_SSL_PROTO_DTLS)
1491 ssl->next_record_offset = 0;
1492 ssl->in_epoch = 0;
1493#endif
1494
1495 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001499 }
1500
Ronald Cronad8c17b2022-06-10 17:18:09 +02001501 ssl->send_alert = 0;
1502
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 /* Reset outgoing message writing */
1504 ssl->out_msgtype = 0;
1505 ssl->out_msglen = 0;
1506 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 memset(ssl->out_buf, 0, out_buf_len);
1508 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 ssl->transform_out = NULL;
1510
1511#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513#endif
1514
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 if (ssl->transform) {
1517 mbedtls_ssl_transform_free(ssl->transform);
1518 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519 ssl->transform = NULL;
1520 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1522
XiaokangQian2b01dc32022-01-21 02:53:13 +00001523#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->transform_application);
1525 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->transform_application = NULL;
1527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001529#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1531 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001533#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1536 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 ssl->handshake->transform_handshake = NULL;
1538 }
1539
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001541}
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544{
1545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1546
1547 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550
1551 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#if defined(MBEDTLS_SSL_RENEGOTIATION)
1553 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001554 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
1556 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1558 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
Hanno Beckerb0302c42021-08-03 09:39:42 +01001562 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001563 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 if (ssl->session) {
1565 mbedtls_ssl_session_free(ssl->session);
1566 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001567 ssl->session = NULL;
1568 }
1569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001571 ssl->alpn_chosen = NULL;
1572#endif
1573
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001574#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001575 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001576#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001578#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 if (free_cli_id) {
1580 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001581 ssl->cli_id = NULL;
1582 ssl->cli_id_len = 0;
1583 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001584#endif
1585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if ((ret = ssl_handshake_init(ssl)) != 0) {
1587 return ret;
1588 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001591}
1592
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001593/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594 * Reset an initialized and used SSL context for re-use while retaining
1595 * all application-set variables, function pointers and data.
1596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001598{
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600}
1601
1602/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001603 * SSL set accessors
1604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001606{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001607 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001608}
1609
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001613}
1614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001619}
1620#endif
1621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1630 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001631{
1632 ssl->disable_datagram_packing = !allow_packing;
1633}
1634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1636 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001637{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001638 conf->hs_timeout_min = min;
1639 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001640}
1641#endif
1642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001645 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646}
1647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1650 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1651 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001652{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001653 conf->f_vrfy = f_vrfy;
1654 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001655}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001657
Gilles Peskine449bd832023-01-11 14:50:10 +01001658void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1659 int (*f_rng)(void *, unsigned char *, size_t),
1660 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001661{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001662 conf->f_rng = f_rng;
1663 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001664}
1665
Gilles Peskine449bd832023-01-11 14:50:10 +01001666void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1667 void (*f_dbg)(void *, int, const char *, int, const char *),
1668 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001669{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001670 conf->f_dbg = f_dbg;
1671 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001672}
1673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1675 void *p_bio,
1676 mbedtls_ssl_send_t *f_send,
1677 mbedtls_ssl_recv_t *f_recv,
1678 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001679{
1680 ssl->p_bio = p_bio;
1681 ssl->f_send = f_send;
1682 ssl->f_recv = f_recv;
1683 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001684}
1685
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001686#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001688{
1689 ssl->mtu = mtu;
1690}
1691#endif
1692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001694{
1695 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001696}
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1699 void *p_timer,
1700 mbedtls_ssl_set_timer_t *f_set_timer,
1701 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001702{
1703 ssl->p_timer = p_timer;
1704 ssl->f_set_timer = f_set_timer;
1705 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001706
1707 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001709}
1710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001712void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1713 void *p_cache,
1714 mbedtls_ssl_cache_get_t *f_get_cache,
1715 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001716{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001717 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001719 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001720}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001724int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001725{
Janos Follath865b3eb2019-12-16 11:46:15 +00001726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001729 session == NULL ||
1730 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733 }
1734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (ssl->handshake->resume == 1) {
1736 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1737 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001738
Jerry Yu21092062022-10-10 21:21:31 +08001739#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001745 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1747 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1748 session->ciphersuite));
1749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001750 }
Jerry Yu40afab62022-10-08 10:42:13 +08001751 }
Jerry Yu21092062022-10-10 21:21:31 +08001752#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1755 session)) != 0) {
1756 return ret;
1757 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001758
Paul Bakker0a597072012-09-25 21:55:46 +00001759 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001762}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1766 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001767{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001768 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001769}
1770
Ronald Cron6f135e12021-12-08 16:57:54 +01001771#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001772void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1773 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001774{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001775 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001776}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001777
1778#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001779void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1780 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001781{
1782 conf->early_data_enabled = early_data_enabled;
1783}
Jerry Yucc4e0072022-11-22 17:22:22 +08001784
1785#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001786void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001788{
Jerry Yu39da9852022-12-06 16:58:36 +08001789 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001790}
1791#endif /* MBEDTLS_SSL_SRV_C */
1792
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001793#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001794#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001797void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1798 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001799{
1800 conf->cert_profile = profile;
1801}
1802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001804{
1805 mbedtls_ssl_key_cert *cur = key_cert, *next;
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001808 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001810 cur = next;
1811 }
1812}
1813
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001814/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001815MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001816static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1817 mbedtls_x509_crt *cert,
1818 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001819{
niisato8ee24222018-06-25 19:05:48 +09001820 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001823 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001825 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001827 }
1828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1830 if (new_cert == NULL) {
1831 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1832 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001833
niisato8ee24222018-06-25 19:05:48 +09001834 new_cert->cert = cert;
1835 new_cert->key = key;
1836 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001837
Glenn Strauss36872db2022-01-22 05:06:31 -05001838 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001840 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001842 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 }
niisato8ee24222018-06-25 19:05:48 +09001846 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001847 }
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850}
1851
Gilles Peskine449bd832023-01-11 14:50:10 +01001852int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001853 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001855{
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001857}
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001860 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001862{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001863 conf->ca_chain = ca_chain;
1864 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001865
1866#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1867 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1868 * cannot be used together. */
1869 conf->f_ca_cb = NULL;
1870 conf->p_ca_cb = NULL;
1871#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001872}
Hanno Becker5adaad92019-03-27 16:54:37 +00001873
1874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001875void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1876 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1877 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001878{
1879 conf->f_ca_cb = f_ca_cb;
1880 conf->p_ca_cb = p_ca_cb;
1881
1882 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1883 * cannot be used together. */
1884 conf->ca_chain = NULL;
1885 conf->ca_crl = NULL;
1886}
1887#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001889
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001890#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001891const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1892 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001893{
1894 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001896}
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1899 mbedtls_x509_crt *own_cert,
1900 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001901{
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1903 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001904}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1907 mbedtls_x509_crt *ca_chain,
1908 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001909{
1910 ssl->handshake->sni_ca_chain = ca_chain;
1911 ssl->handshake->sni_ca_crl = ca_crl;
1912}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001913
Glenn Strauss999ef702022-03-11 01:37:23 -05001914#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001915void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1916 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001917{
1918 ssl->handshake->dn_hints = crt;
1919}
1920#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1923 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001924{
1925 ssl->handshake->sni_authmode = authmode;
1926}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001927#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1928
Hanno Becker8927c832019-04-03 12:52:50 +01001929#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1931 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1932 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001933{
1934 ssl->f_vrfy = f_vrfy;
1935 ssl->p_vrfy = p_vrfy;
1936}
1937#endif
1938
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001939#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001940
Valerio Setti016f6822022-12-09 14:17:50 +01001941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001942static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1943static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1944
Valerio Setti016f6822022-12-09 14:17:50 +01001945static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 mbedtls_ssl_context *ssl,
1947 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001948{
1949 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001950 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001951 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001952 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001953 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001954 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1956 psa_pake_cs_set_primitive(&cipher_suite,
1957 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1958 PSA_ECC_FAMILY_SECP_R1,
1959 256));
1960 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1963 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001964 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001968 user = jpake_server_id;
1969 user_len = sizeof(jpake_server_id);
1970 peer = jpake_client_id;
1971 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 user = jpake_client_id;
1974 user_len = sizeof(jpake_client_id);
1975 peer = jpake_server_id;
1976 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001978
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001979 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1980 if (status != PSA_SUCCESS) {
1981 return status;
1982 }
1983
1984 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001986 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
Valerio Setti016f6822022-12-09 14:17:50 +01001988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1990 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
1994 ssl->handshake->psa_pake_ctx_is_ok = 1;
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001997}
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2000 const unsigned char *pw,
2001 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002002{
2003 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2004 psa_status_t status;
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 if (ssl->handshake == NULL || ssl->conf == NULL) {
2007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002008 }
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 /* Empty password is not valid */
2011 if ((pw == NULL) || (pw_len == 0)) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2013 }
2014
2015 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2016 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2017 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2018
2019 status = psa_import_key(&attributes, pw, pw_len,
2020 &ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2023 }
2024
2025 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2026 ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 psa_destroy_key(ssl->handshake->psa_pake_password);
2029 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2030 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2031 }
2032
2033 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002034}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2037 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002038{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002039 psa_status_t status;
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 if (ssl->handshake == NULL || ssl->conf == NULL) {
2042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002043 }
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (mbedtls_svc_key_id_is_null(pwd)) {
2046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2047 }
2048
2049 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2050 if (status != PSA_SUCCESS) {
2051 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2052 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2053 }
2054
2055 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002056}
2057#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002058int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2059 const unsigned char *pw,
2060 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061{
2062 mbedtls_ecjpake_role role;
2063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (ssl->handshake == NULL || ssl->conf == NULL) {
2065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2066 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067
Valerio Settic689ed82022-12-07 14:40:38 +01002068 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if ((pw == NULL) || (pw_len == 0)) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Valerio Settic689ed82022-12-07 14:40:38 +01002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002076 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2080 role,
2081 MBEDTLS_MD_SHA256,
2082 MBEDTLS_ECP_DP_SECP256R1,
2083 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084}
Valerio Setti02c25b52022-11-15 14:08:42 +01002085#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002086#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002087
Ronald Cron73fe8df2022-10-05 14:31:43 +02002088#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090{
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (conf->psk_identity == NULL ||
2092 conf->psk_identity_len == 0) {
2093 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002094 }
2095
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2098 return 1;
2099 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (conf->psk != NULL && conf->psk_len != 0) {
2103 return 1;
2104 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107}
2108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002110{
2111 /* Remove reference to existing PSK, if any. */
2112#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114 /* The maintenance of the PSK key slot is the
2115 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002116 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002120 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 conf->psk = NULL;
2122 conf->psk_len = 0;
2123 }
2124
2125 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk_identity != NULL) {
2127 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 conf->psk_identity = NULL;
2129 conf->psk_identity_len = 0;
2130 }
2131}
2132
Hanno Becker7390c712018-11-15 13:33:04 +00002133/* This function assumes that PSK identity in the SSL config is unset.
2134 * It checks that the provided identity is well-formed and attempts
2135 * to make a copy of it in the SSL config.
2136 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002138static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2139 unsigned char const *psk_identity,
2140 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002141{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002144 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 (psk_identity_len >> 16) != 0 ||
2146 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2147 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 }
2149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2151 if (conf->psk_identity == NULL) {
2152 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2153 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002154
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002155 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002159}
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2162 const unsigned char *psk, size_t psk_len,
2163 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002164{
Janos Follath865b3eb2019-12-16 11:46:15 +00002165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002166
2167 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2169 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2170 }
Hanno Becker7390c712018-11-15 13:33:04 +00002171
2172 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (psk == NULL) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
2176 if (psk_len == 0) {
2177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2178 }
2179 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2184 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2185 }
Hanno Becker7390c712018-11-15 13:33:04 +00002186 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002188
2189 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2191 if (ret != 0) {
2192 ssl_conf_remove_psk(conf);
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002196}
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002199{
2200#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002202 /* The maintenance of the external PSK key slot is the
2203 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (ssl->handshake->psk_opaque_is_internal) {
2205 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002206 ssl->handshake->psk_opaque_is_internal = 0;
2207 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002208 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002212 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002214 ssl->handshake->psk_len = 0;
2215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217}
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2220 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002221{
Neil Armstrong501c9322022-05-03 09:35:09 +02002222#if defined(MBEDTLS_USE_PSA_CRYPTO)
2223 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002224 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002225 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002226 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002227#endif /* MBEDTLS_USE_PSA_CRYPTO */
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (psk == NULL || ssl->handshake == NULL) {
2230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2231 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2234 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2235 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Neil Armstrong501c9322022-05-03 09:35:09 +02002239#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002240#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2242 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2243 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2244 } else {
2245 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2246 }
2247 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002248 }
2249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002250
Jerry Yu568ec252022-07-22 21:27:34 +08002251#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2253 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2254 psa_set_key_usage_flags(&key_attributes,
2255 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002256 }
2257#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 psa_set_key_algorithm(&key_attributes, alg);
2260 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2263 if (status != PSA_SUCCESS) {
2264 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2265 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002266
2267 /* Allow calling psa_destroy_key() on psk remove */
2268 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2272 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2273 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274
2275 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280}
2281
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002282#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002283int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2284 mbedtls_svc_key_id_t psk,
2285 const unsigned char *psk_identity,
2286 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002287{
Janos Follath865b3eb2019-12-16 11:46:15 +00002288 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002289
2290 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2293 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002294
Hanno Becker7390c712018-11-15 13:33:04 +00002295 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (mbedtls_svc_key_id_is_null(psk)) {
2297 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2298 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002299 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002300
2301 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2303 psk_identity_len);
2304 if (ret != 0) {
2305 ssl_conf_remove_psk(conf);
2306 }
Hanno Becker7390c712018-11-15 13:33:04 +00002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002309}
2310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2312 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002313{
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if ((mbedtls_svc_key_id_is_null(psk)) ||
2315 (ssl->handshake == NULL)) {
2316 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2317 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002320 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322}
2323#endif /* MBEDTLS_USE_PSA_CRYPTO */
2324
Jerry Yu8897c072022-08-12 13:56:53 +08002325#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002326void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2327 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2328 size_t),
2329 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330{
2331 conf->f_psk = f_psk;
2332 conf->p_psk = p_psk;
2333}
Jerry Yu8897c072022-08-12 13:56:53 +08002334#endif /* MBEDTLS_SSL_SRV_C */
2335
Ronald Cron73fe8df2022-10-05 14:31:43 +02002336#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002337
2338#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002339static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002341{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002342#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (alg == PSA_ALG_CBC_NO_PADDING) {
2344 return MBEDTLS_SSL_MODE_CBC;
2345 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002346#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (PSA_ALG_IS_AEAD(alg)) {
2348 return MBEDTLS_SSL_MODE_AEAD;
2349 }
2350 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002351}
2352
2353#else /* MBEDTLS_USE_PSA_CRYPTO */
2354
2355static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002357{
2358#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 if (mode == MBEDTLS_MODE_CBC) {
2360 return MBEDTLS_SSL_MODE_CBC;
2361 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002362#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2363
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002364#if defined(MBEDTLS_GCM_C) || \
2365 defined(MBEDTLS_CCM_C) || \
2366 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 mode == MBEDTLS_MODE_CHACHAPOLY) {
2370 return MBEDTLS_SSL_MODE_AEAD;
2371 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002375}
Gilles Peskine301711e2022-04-26 16:57:05 +02002376#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377
Gilles Peskinee108d982022-04-26 16:50:40 +02002378static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2379 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002381{
2382#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2384 base_mode == MBEDTLS_SSL_MODE_CBC) {
2385 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002386 }
2387#else
2388 (void) encrypt_then_mac;
2389#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002391}
2392
Neil Armstrongab555e02022-04-04 11:07:59 +02002393mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002395{
Gilles Peskinee108d982022-04-26 16:50:40 +02002396 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002399#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002401#endif
2402 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403
Gilles Peskinee108d982022-04-26 16:50:40 +02002404 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002405#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002406 encrypt_then_mac = transform->encrypt_then_mac;
2407#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409}
2410
Neil Armstrongab555e02022-04-04 11:07:59 +02002411mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416{
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2418
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002419#if defined(MBEDTLS_USE_PSA_CRYPTO)
2420 psa_status_t status;
2421 psa_algorithm_t alg;
2422 psa_key_type_t type;
2423 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002424 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2425 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (status == PSA_SUCCESS) {
2427 base_mode = mbedtls_ssl_get_base_mode(alg);
2428 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#else
2430 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002431 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002433 base_mode =
2434 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437#endif /* MBEDTLS_USE_PSA_CRYPTO */
2438
Gilles Peskinee108d982022-04-26 16:50:40 +02002439#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2440 int encrypt_then_mac = 0;
2441#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443}
2444
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002445#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2448 size_t taglen,
2449 psa_algorithm_t *alg,
2450 psa_key_type_t *key_type,
2451 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002452{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002453#if !defined(MBEDTLS_SSL_HAVE_CCM)
2454 (void) taglen;
2455#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002457#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002458 case MBEDTLS_CIPHER_AES_128_CBC:
2459 *alg = PSA_ALG_CBC_NO_PADDING;
2460 *key_type = PSA_KEY_TYPE_AES;
2461 *key_size = 128;
2462 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002463#endif
2464#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002465 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002467 *key_type = PSA_KEY_TYPE_AES;
2468 *key_size = 128;
2469 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002470#endif
2471#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002472 case MBEDTLS_CIPHER_AES_128_GCM:
2473 *alg = PSA_ALG_GCM;
2474 *key_type = PSA_KEY_TYPE_AES;
2475 *key_size = 128;
2476 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002477#endif
2478#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002479 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002481 *key_type = PSA_KEY_TYPE_AES;
2482 *key_size = 192;
2483 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002484#endif
2485#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 case MBEDTLS_CIPHER_AES_192_GCM:
2487 *alg = PSA_ALG_GCM;
2488 *key_type = PSA_KEY_TYPE_AES;
2489 *key_size = 192;
2490 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002491#endif
2492#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002493 case MBEDTLS_CIPHER_AES_256_CBC:
2494 *alg = PSA_ALG_CBC_NO_PADDING;
2495 *key_type = PSA_KEY_TYPE_AES;
2496 *key_size = 256;
2497 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002498#endif
2499#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 *key_type = PSA_KEY_TYPE_AES;
2503 *key_size = 256;
2504 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002505#endif
2506#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002507 case MBEDTLS_CIPHER_AES_256_GCM:
2508 *alg = PSA_ALG_GCM;
2509 *key_type = PSA_KEY_TYPE_AES;
2510 *key_size = 256;
2511 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002512#endif
2513#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002514 case MBEDTLS_CIPHER_ARIA_128_CBC:
2515 *alg = PSA_ALG_CBC_NO_PADDING;
2516 *key_type = PSA_KEY_TYPE_ARIA;
2517 *key_size = 128;
2518 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002519#endif
2520#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 *key_type = PSA_KEY_TYPE_ARIA;
2524 *key_size = 128;
2525 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002526#endif
2527#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002528 case MBEDTLS_CIPHER_ARIA_128_GCM:
2529 *alg = PSA_ALG_GCM;
2530 *key_type = PSA_KEY_TYPE_ARIA;
2531 *key_size = 128;
2532 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002533#endif
2534#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002535 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 *key_type = PSA_KEY_TYPE_ARIA;
2538 *key_size = 192;
2539 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002540#endif
2541#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 case MBEDTLS_CIPHER_ARIA_192_GCM:
2543 *alg = PSA_ALG_GCM;
2544 *key_type = PSA_KEY_TYPE_ARIA;
2545 *key_size = 192;
2546 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002547#endif
2548#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002549 case MBEDTLS_CIPHER_ARIA_256_CBC:
2550 *alg = PSA_ALG_CBC_NO_PADDING;
2551 *key_type = PSA_KEY_TYPE_ARIA;
2552 *key_size = 256;
2553 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002554#endif
2555#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 *key_type = PSA_KEY_TYPE_ARIA;
2559 *key_size = 256;
2560 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002561#endif
2562#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002563 case MBEDTLS_CIPHER_ARIA_256_GCM:
2564 *alg = PSA_ALG_GCM;
2565 *key_type = PSA_KEY_TYPE_ARIA;
2566 *key_size = 256;
2567 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002568#endif
2569#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002570 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2571 *alg = PSA_ALG_CBC_NO_PADDING;
2572 *key_type = PSA_KEY_TYPE_CAMELLIA;
2573 *key_size = 128;
2574 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002575#endif
2576#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 *key_type = PSA_KEY_TYPE_CAMELLIA;
2580 *key_size = 128;
2581 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002582#endif
2583#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002584 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2585 *alg = PSA_ALG_GCM;
2586 *key_type = PSA_KEY_TYPE_CAMELLIA;
2587 *key_size = 128;
2588 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002589#endif
2590#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002591 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 *key_type = PSA_KEY_TYPE_CAMELLIA;
2594 *key_size = 192;
2595 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002596#endif
2597#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2599 *alg = PSA_ALG_GCM;
2600 *key_type = PSA_KEY_TYPE_CAMELLIA;
2601 *key_size = 192;
2602 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002603#endif
2604#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002605 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2606 *alg = PSA_ALG_CBC_NO_PADDING;
2607 *key_type = PSA_KEY_TYPE_CAMELLIA;
2608 *key_size = 256;
2609 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002610#endif
2611#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 *key_type = PSA_KEY_TYPE_CAMELLIA;
2615 *key_size = 256;
2616 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002617#endif
2618#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002619 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2620 *alg = PSA_ALG_GCM;
2621 *key_type = PSA_KEY_TYPE_CAMELLIA;
2622 *key_size = 256;
2623 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002624#endif
2625#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002626 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2627 *alg = PSA_ALG_CHACHA20_POLY1305;
2628 *key_type = PSA_KEY_TYPE_CHACHA20;
2629 *key_size = 256;
2630 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002631#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002632 case MBEDTLS_CIPHER_NULL:
2633 *alg = MBEDTLS_SSL_NULL_CIPHER;
2634 *key_type = 0;
2635 *key_size = 0;
2636 break;
2637 default:
2638 return PSA_ERROR_NOT_SUPPORTED;
2639 }
2640
2641 return PSA_SUCCESS;
2642}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002643#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002644
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002645#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002646int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2647 const unsigned char *dhm_P, size_t P_len,
2648 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002649{
Janos Follath865b3eb2019-12-16 11:46:15 +00002650 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 mbedtls_mpi_free(&conf->dhm_P);
2653 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2656 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2657 mbedtls_mpi_free(&conf->dhm_P);
2658 mbedtls_mpi_free(&conf->dhm_G);
2659 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002660 }
2661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002663}
Paul Bakker5121ce52009-01-03 21:22:43 +00002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002666{
Janos Follath865b3eb2019-12-16 11:46:15 +00002667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 mbedtls_mpi_free(&conf->dhm_P);
2670 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2673 &conf->dhm_P)) != 0 ||
2674 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2675 &conf->dhm_G)) != 0) {
2676 mbedtls_mpi_free(&conf->dhm_P);
2677 mbedtls_mpi_free(&conf->dhm_G);
2678 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002679 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002682}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002683#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002684
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002685#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2686/*
2687 * Set the minimum length for Diffie-Hellman parameters
2688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2690 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002691{
2692 conf->dhm_min_bitlen = bitlen;
2693}
2694#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2695
Ronald Crone68ab4f2022-10-05 12:46:29 +02002696#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002697#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002698/*
2699 * Set allowed/preferred hashes for handshake signatures
2700 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2702 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002703{
2704 conf->sig_hashes = hashes;
2705}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002706#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002707
Jerry Yuf017ee42022-01-12 15:49:48 +08002708/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2710 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002711{
Jerry Yuf017ee42022-01-12 15:49:48 +08002712#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2713 conf->sig_hashes = NULL;
2714#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2715 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002716}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002717#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002718
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002719#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002720#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002721/*
2722 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002723 *
2724 * mbedtls_ssl_setup() takes the provided list
2725 * and translates it to a list of IANA TLS group identifiers,
2726 * stored in ssl->handshake->group_list.
2727 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002728 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002729void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2730 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002731{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002732 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002733 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002734}
Brett Warrene0edc842021-08-17 09:53:13 +01002735#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002736#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737
Brett Warrene0edc842021-08-17 09:53:13 +01002738/*
2739 * Set the allowed groups
2740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2742 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002743{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002744#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002745 conf->curve_list = NULL;
2746#endif
2747 conf->group_list = group_list;
2748}
2749
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002750#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002751int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002752{
Hanno Becker947194e2017-04-07 13:25:49 +01002753 /* Initialize to suppress unnecessary compiler warning */
2754 size_t hostname_len = 0;
2755
2756 /* Check if new hostname is valid before
2757 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 if (hostname != NULL) {
2759 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2763 }
Hanno Becker947194e2017-04-07 13:25:49 +01002764 }
2765
2766 /* Now it's clear that we will overwrite the old hostname,
2767 * so we can free it safely */
2768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002770 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002771 }
2772
2773 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002776 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 } else {
2778 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2779 if (ssl->hostname == NULL) {
2780 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2781 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002784
Hanno Becker947194e2017-04-07 13:25:49 +01002785 ssl->hostname[hostname_len] = '\0';
2786 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002789}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002790#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002791
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002792#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002793void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2794 int (*f_sni)(void *, mbedtls_ssl_context *,
2795 const unsigned char *, size_t),
2796 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002797{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002798 conf->f_sni = f_sni;
2799 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002800}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002804int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002805{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002806 size_t cur_len, tot_len;
2807 const char **p;
2808
2809 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002810 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2811 * MUST NOT be truncated."
2812 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002813 */
2814 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 for (p = protos; *p != NULL; p++) {
2816 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002817 tot_len += cur_len;
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if ((cur_len == 0) ||
2820 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2821 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2823 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002824 }
2825
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002826 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002829}
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002832{
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002834}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002836
Johan Pascalb62bb512015-12-03 21:56:45 +01002837#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002838void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2839 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002840{
2841 conf->dtls_srtp_mki_support = support_mki_value;
2842}
2843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2845 unsigned char *mki_value,
2846 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002847{
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2849 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002850 }
Ron Eldor591f1622018-01-22 12:30:04 +02002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2853 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002854 }
Ron Eldor591f1622018-01-22 12:30:04 +02002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002857 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002859}
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2862 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002863{
Johan Pascal253d0262020-09-22 13:04:45 +02002864 const mbedtls_ssl_srtp_profile *p;
2865 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002866
Johan Pascal253d0262020-09-22 13:04:45 +02002867 /* check the profiles list: all entry must be valid,
2868 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2870 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2871 p++) {
2872 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002873 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002875 /* unsupported value, stop parsing and set the size to an error value */
2876 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002877 }
2878 }
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2881 conf->dtls_srtp_profile_list = NULL;
2882 conf->dtls_srtp_profile_list_len = 0;
2883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002884 }
2885
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002886 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002887 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002890}
2891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2893 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002894{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002895 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2896 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002898 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002900 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2902 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002903 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002904}
Johan Pascalb62bb512015-12-03 21:56:45 +01002905#endif /* MBEDTLS_SSL_DTLS_SRTP */
2906
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302907#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002908void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002909{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002910 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002911}
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002914{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002915 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002916}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302917#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002918
Janos Follath088ce432017-04-10 12:42:31 +01002919#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002920void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2921 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002922{
2923 conf->cert_req_ca_list = cert_req_ca_list;
2924}
2925#endif
2926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002928void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002929{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002930 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002931}
2932#endif
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002936{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002938}
2939#endif
2940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002942int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002943{
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2945 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002947 }
2948
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002949 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002952}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002956{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002957 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002958}
2959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002961void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002962{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002963 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002964}
2965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002967{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002968 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002969}
2970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2972 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002973{
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002975}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002979#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002980void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002981{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002982 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002983}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002984#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002985
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002986#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002987
Jerry Yud0766ec2022-09-22 10:46:57 +08002988#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002989void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2990 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002991{
Jerry Yud0766ec2022-09-22 10:46:57 +08002992 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002993}
2994#endif
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2997 mbedtls_ssl_ticket_write_t *f_ticket_write,
2998 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2999 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003000{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003001 conf->f_ticket_write = f_ticket_write;
3002 conf->f_ticket_parse = f_ticket_parse;
3003 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003004}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003005#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3009 mbedtls_ssl_export_keys_t *f_export_keys,
3010 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003011{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003012 ssl->f_export_keys = f_export_keys;
3013 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003014}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003015
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003016#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003017void mbedtls_ssl_conf_async_private_cb(
3018 mbedtls_ssl_config *conf,
3019 mbedtls_ssl_async_sign_t *f_async_sign,
3020 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3021 mbedtls_ssl_async_resume_t *f_async_resume,
3022 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003024{
3025 conf->f_async_sign_start = f_async_sign;
3026 conf->f_async_decrypt_start = f_async_decrypt;
3027 conf->f_async_resume = f_async_resume;
3028 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003029 conf->p_async_config_data = async_config_data;
3030}
3031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003033{
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003035}
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003038{
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ssl->handshake == NULL) {
3040 return NULL;
3041 } else {
3042 return ssl->handshake->user_async_ctx;
3043 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003044}
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3047 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003048{
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003050 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003052}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003053#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003054
Paul Bakker5121ce52009-01-03 21:22:43 +00003055/*
3056 * SSL get accessors
3057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003058uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003059{
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl->session != NULL) {
3061 return ssl->session->verify_result;
3062 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (ssl->session_negotiate != NULL) {
3065 return ssl->session_negotiate->verify_result;
3066 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003069}
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003072{
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (ssl == NULL || ssl->session == NULL) {
3074 return 0;
3075 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003078}
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003081{
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (ssl == NULL || ssl->session == NULL) {
3083 return NULL;
3084 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003087}
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003090{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3093 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003094 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003096 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003098 }
3099 }
3100#endif
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003103 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003105 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003107 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003109 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003110}
3111
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003112#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3113
3114size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3115{
3116 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3117 size_t record_size_limit = max_len;
3118
3119 if (ssl->session != NULL &&
3120 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3121 ssl->session->record_size_limit < max_len) {
3122 record_size_limit = ssl->session->record_size_limit;
3123 }
3124
3125 // TODO: this is currently untested
3126 /* During a handshake, use the value being negotiated */
3127 if (ssl->session_negotiate != NULL &&
3128 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3129 ssl->session_negotiate->record_size_limit < max_len) {
3130 record_size_limit = ssl->session_negotiate->record_size_limit;
3131 }
3132
3133 return record_size_limit;
3134}
3135#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3136
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003137#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003138size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003139{
David Horstmann95d516f2021-05-04 18:36:56 +01003140 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003141 size_t read_mfl;
3142
Jerry Yuddda0502022-12-01 19:43:12 +08003143#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003144 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3146 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3147 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003148 }
Jerry Yuddda0502022-12-01 19:43:12 +08003149#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003150
3151 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl->session_out != NULL) {
3153 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3154 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003155 max_len = read_mfl;
3156 }
3157 }
3158
Jerry Yuddda0502022-12-01 19:43:12 +08003159 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (ssl->session_negotiate != NULL) {
3161 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3162 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003163 max_len = read_mfl;
3164 }
3165 }
3166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003171{
3172 size_t max_len;
3173
3174 /*
3175 * Assume mfl_code is correct since it was checked when set
3176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003178
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003179 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 if (ssl->session_out != NULL &&
3181 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3182 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003183 }
3184
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003185 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 if (ssl->session_negotiate != NULL &&
3187 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3188 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003189 }
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003192}
3193#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3194
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003195#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003196size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003197{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003198 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3200 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3201 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3202 return 0;
3203 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3206 return ssl->mtu;
3207 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 if (ssl->mtu == 0) {
3210 return ssl->handshake->mtu;
3211 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 return ssl->mtu < ssl->handshake->mtu ?
3214 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003215}
3216#endif /* MBEDTLS_SSL_PROTO_DTLS */
3217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003219{
3220 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3221
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003222#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003223 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003224 !defined(MBEDTLS_SSL_PROTO_DTLS)
3225 (void) ssl;
3226#endif
3227
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003228#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003232 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003234#endif
3235
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003236#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3237 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3238
3239 if (max_len > record_size_limit) {
3240 max_len = record_size_limit;
3241 }
3242#endif
3243
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003244 if (ssl->transform_out != NULL &&
3245 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003246 /*
3247 * In TLS 1.3 case, when records are protected, `max_len` as computed
3248 * above is the maximum length of the TLSInnerPlaintext structure that
3249 * along the plaintext payload contains the inner content type (one byte)
3250 * and some zero padding. Given the algorithm used for padding
3251 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3252 * the plaintext payload. Round down to a multiple of
3253 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3254 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003255 */
3256 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3257 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3258 }
3259
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003260#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3262 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3263 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264 const size_t overhead = (size_t) ret;
3265
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ret < 0) {
3267 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003268 }
3269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (mtu <= overhead) {
3271 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3273 }
3274
3275 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003276 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003278 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003279#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003280
Hanno Becker0defedb2018-08-10 12:35:02 +01003281#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003282 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3283 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003284 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285#endif
3286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003288}
3289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003291{
3292 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3293
3294#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3295 (void) ssl;
3296#endif
3297
3298#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003302 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003304#endif
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003307}
3308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003310const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (ssl == NULL || ssl->session == NULL) {
3313 return NULL;
3314 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003315
Hanno Beckere6824572019-02-07 13:18:46 +00003316#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003320#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003321}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003325int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3326 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003327{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003328 int ret;
3329
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003331 dst == NULL ||
3332 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3334 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003335 }
3336
Hanno Beckere810bbc2021-05-14 16:01:05 +01003337 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3338 * idempotent: Each session can only be exported once.
3339 *
3340 * (This is in preparation for TLS 1.3 support where we will
3341 * need the ability to export multiple sessions (aka tickets),
3342 * which will be achieved by calling mbedtls_ssl_get_session()
3343 * multiple times until it fails.)
3344 *
3345 * Check whether we have already exported the current session,
3346 * and fail if so.
3347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (ssl->session->exported == 1) {
3349 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3350 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3353 if (ret != 0) {
3354 return ret;
3355 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003356
3357 /* Remember that we've exported the session. */
3358 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003360}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003362
David Horstmanne59f9702024-02-29 16:08:57 +00003363/* Serialization of TLS 1.2 sessions:
3364 *
3365 * struct {
3366 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3367 * uint32 ticket_lifetime;
3368 * } ClientOnlyData;
3369 *
3370 * struct {
3371 * uint64 start_time;
3372 * uint8 session_id_len; // at most 32
3373 * opaque session_id[32];
3374 * opaque master[48]; // fixed length in the standard
3375 * uint32 verify_result;
3376 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3377 * select (endpoint) {
3378 * case client: ClientOnlyData;
3379 * case server: uint64 ticket_creation_time;
3380 * };
3381 * uint8 mfl_code; // up to 255 according to standard
3382 * uint8 encrypt_then_mac; // 0 or 1
3383 * } serialized_session_tls12;
3384 */
3385static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3386 unsigned char *buf,
3387 size_t buf_len)
3388{
3389 unsigned char *p = buf;
3390 size_t used = 0;
3391
3392#if defined(MBEDTLS_HAVE_TIME)
3393 uint64_t start;
3394#endif
3395#if defined(MBEDTLS_X509_CRT_PARSE_C)
3396#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3397 size_t cert_len;
3398#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3399#endif /* MBEDTLS_X509_CRT_PARSE_C */
3400
3401 /*
3402 * Time
3403 */
3404#if defined(MBEDTLS_HAVE_TIME)
3405 used += 8;
3406
3407 if (used <= buf_len) {
3408 start = (uint64_t) session->start;
3409
3410 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3411 p += 8;
3412 }
3413#endif /* MBEDTLS_HAVE_TIME */
3414
3415 /*
3416 * Basic mandatory fields
3417 */
3418 used += 1 /* id_len */
3419 + sizeof(session->id)
3420 + sizeof(session->master)
3421 + 4; /* verify_result */
3422
3423 if (used <= buf_len) {
3424 *p++ = MBEDTLS_BYTE_0(session->id_len);
3425 memcpy(p, session->id, 32);
3426 p += 32;
3427
3428 memcpy(p, session->master, 48);
3429 p += 48;
3430
3431 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3432 p += 4;
3433 }
3434
3435 /*
3436 * Peer's end-entity certificate
3437 */
3438#if defined(MBEDTLS_X509_CRT_PARSE_C)
3439#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3440 if (session->peer_cert == NULL) {
3441 cert_len = 0;
3442 } else {
3443 cert_len = session->peer_cert->raw.len;
3444 }
3445
3446 used += 3 + cert_len;
3447
3448 if (used <= buf_len) {
3449 *p++ = MBEDTLS_BYTE_2(cert_len);
3450 *p++ = MBEDTLS_BYTE_1(cert_len);
3451 *p++ = MBEDTLS_BYTE_0(cert_len);
3452
3453 if (session->peer_cert != NULL) {
3454 memcpy(p, session->peer_cert->raw.p, cert_len);
3455 p += cert_len;
3456 }
3457 }
3458#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3459 if (session->peer_cert_digest != NULL) {
3460 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3461 if (used <= buf_len) {
3462 *p++ = (unsigned char) session->peer_cert_digest_type;
3463 *p++ = (unsigned char) session->peer_cert_digest_len;
3464 memcpy(p, session->peer_cert_digest,
3465 session->peer_cert_digest_len);
3466 p += session->peer_cert_digest_len;
3467 }
3468 } else {
3469 used += 2;
3470 if (used <= buf_len) {
3471 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3472 *p++ = 0;
3473 }
3474 }
3475#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3476#endif /* MBEDTLS_X509_CRT_PARSE_C */
3477
3478 /*
3479 * Session ticket if any, plus associated data
3480 */
3481#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3482#if defined(MBEDTLS_SSL_CLI_C)
3483 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3484 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3485
3486 if (used <= buf_len) {
3487 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3488 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3489 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3490
3491 if (session->ticket != NULL) {
3492 memcpy(p, session->ticket, session->ticket_len);
3493 p += session->ticket_len;
3494 }
3495
3496 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3497 p += 4;
3498 }
3499 }
3500#endif /* MBEDTLS_SSL_CLI_C */
3501#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3502 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3503 used += 8;
3504
3505 if (used <= buf_len) {
3506 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3507 p += 8;
3508 }
3509 }
3510#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3511#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3512
3513 /*
3514 * Misc extension-related info
3515 */
3516#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3517 used += 1;
3518
3519 if (used <= buf_len) {
3520 *p++ = session->mfl_code;
3521 }
3522#endif
3523
3524#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3525 used += 1;
3526
3527 if (used <= buf_len) {
3528 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3529 }
3530#endif
3531
3532 return used;
3533}
3534
3535MBEDTLS_CHECK_RETURN_CRITICAL
3536static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3537 const unsigned char *buf,
3538 size_t len)
3539{
3540#if defined(MBEDTLS_HAVE_TIME)
3541 uint64_t start;
3542#endif
3543#if defined(MBEDTLS_X509_CRT_PARSE_C)
3544#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3545 size_t cert_len;
3546#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3547#endif /* MBEDTLS_X509_CRT_PARSE_C */
3548
3549 const unsigned char *p = buf;
3550 const unsigned char * const end = buf + len;
3551
3552 /*
3553 * Time
3554 */
3555#if defined(MBEDTLS_HAVE_TIME)
3556 if (8 > (size_t) (end - p)) {
3557 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3558 }
3559
3560 start = MBEDTLS_GET_UINT64_BE(p, 0);
3561 p += 8;
3562
3563 session->start = (time_t) start;
3564#endif /* MBEDTLS_HAVE_TIME */
3565
3566 /*
3567 * Basic mandatory fields
3568 */
3569 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3570 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3571 }
3572
3573 session->id_len = *p++;
3574 memcpy(session->id, p, 32);
3575 p += 32;
3576
3577 memcpy(session->master, p, 48);
3578 p += 48;
3579
3580 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3581 p += 4;
3582
3583 /* Immediately clear invalid pointer values that have been read, in case
3584 * we exit early before we replaced them with valid ones. */
3585#if defined(MBEDTLS_X509_CRT_PARSE_C)
3586#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3587 session->peer_cert = NULL;
3588#else
3589 session->peer_cert_digest = NULL;
3590#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3591#endif /* MBEDTLS_X509_CRT_PARSE_C */
3592#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3593 session->ticket = NULL;
3594#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3595
3596 /*
3597 * Peer certificate
3598 */
3599#if defined(MBEDTLS_X509_CRT_PARSE_C)
3600#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3601 /* Deserialize CRT from the end of the ticket. */
3602 if (3 > (size_t) (end - p)) {
3603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3604 }
3605
3606 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3607 p += 3;
3608
3609 if (cert_len != 0) {
3610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3611
3612 if (cert_len > (size_t) (end - p)) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3614 }
3615
3616 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3617
3618 if (session->peer_cert == NULL) {
3619 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3620 }
3621
3622 mbedtls_x509_crt_init(session->peer_cert);
3623
3624 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3625 p, cert_len)) != 0) {
3626 mbedtls_x509_crt_free(session->peer_cert);
3627 mbedtls_free(session->peer_cert);
3628 session->peer_cert = NULL;
3629 return ret;
3630 }
3631
3632 p += cert_len;
3633 }
3634#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3635 /* Deserialize CRT digest from the end of the ticket. */
3636 if (2 > (size_t) (end - p)) {
3637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3638 }
3639
3640 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3641 session->peer_cert_digest_len = (size_t) *p++;
3642
3643 if (session->peer_cert_digest_len != 0) {
3644 const mbedtls_md_info_t *md_info =
3645 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3646 if (md_info == NULL) {
3647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3648 }
3649 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3651 }
3652
3653 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
3656
3657 session->peer_cert_digest =
3658 mbedtls_calloc(1, session->peer_cert_digest_len);
3659 if (session->peer_cert_digest == NULL) {
3660 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3661 }
3662
3663 memcpy(session->peer_cert_digest, p,
3664 session->peer_cert_digest_len);
3665 p += session->peer_cert_digest_len;
3666 }
3667#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3668#endif /* MBEDTLS_X509_CRT_PARSE_C */
3669
3670 /*
3671 * Session ticket and associated data
3672 */
3673#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3674#if defined(MBEDTLS_SSL_CLI_C)
3675 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3676 if (3 > (size_t) (end - p)) {
3677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3678 }
3679
3680 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3681 p += 3;
3682
3683 if (session->ticket_len != 0) {
3684 if (session->ticket_len > (size_t) (end - p)) {
3685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3686 }
3687
3688 session->ticket = mbedtls_calloc(1, session->ticket_len);
3689 if (session->ticket == NULL) {
3690 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3691 }
3692
3693 memcpy(session->ticket, p, session->ticket_len);
3694 p += session->ticket_len;
3695 }
3696
3697 if (4 > (size_t) (end - p)) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700
3701 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3702 p += 4;
3703 }
3704#endif /* MBEDTLS_SSL_CLI_C */
3705#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3706 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3707 if (8 > (size_t) (end - p)) {
3708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3711 p += 8;
3712 }
3713#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3714#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3715
3716 /*
3717 * Misc extension-related info
3718 */
3719#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3720 if (1 > (size_t) (end - p)) {
3721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3722 }
3723
3724 session->mfl_code = *p++;
3725#endif
3726
3727#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3728 if (1 > (size_t) (end - p)) {
3729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3730 }
3731
3732 session->encrypt_then_mac = *p++;
3733#endif
3734
3735 /* Done, should have consumed entire buffer */
3736 if (p != end) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3738 }
3739
3740 return 0;
3741}
3742
3743#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3744
3745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3746/* Serialization of TLS 1.3 sessions:
3747 *
3748 * struct {
3749 * opaque hostname<0..2^16-1>;
3750 * uint64 ticket_reception_time;
3751 * uint32 ticket_lifetime;
3752 * opaque ticket<1..2^16-1>;
3753 * } ClientOnlyData;
3754 *
3755 * struct {
3756 * uint32 ticket_age_add;
3757 * uint8 ticket_flags;
3758 * opaque resumption_key<0..255>;
3759 * uint32 max_early_data_size;
3760 * uint16 record_size_limit;
3761 * select ( endpoint ) {
3762 * case client: ClientOnlyData;
3763 * case server: uint64 ticket_creation_time;
3764 * };
3765 * } serialized_session_tls13;
3766 *
3767 */
3768#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3769MBEDTLS_CHECK_RETURN_CRITICAL
3770static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3771 unsigned char *buf,
3772 size_t buf_len,
3773 size_t *olen)
3774{
3775 unsigned char *p = buf;
3776#if defined(MBEDTLS_SSL_CLI_C) && \
3777 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3778 size_t hostname_len = (session->hostname == NULL) ?
3779 0 : strlen(session->hostname) + 1;
3780#endif
3781 size_t needed = 4 /* ticket_age_add */
3782 + 1 /* ticket_flags */
3783 + 1; /* resumption_key length */
3784 *olen = 0;
3785
3786 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3788 }
3789 needed += session->resumption_key_len; /* resumption_key */
3790
3791#if defined(MBEDTLS_SSL_EARLY_DATA)
3792 needed += 4; /* max_early_data_size */
3793#endif
3794#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3795 needed += 2; /* record_size_limit */
3796#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3797
3798#if defined(MBEDTLS_HAVE_TIME)
3799 needed += 8; /* ticket_creation_time or ticket_reception_time */
3800#endif
3801
3802#if defined(MBEDTLS_SSL_CLI_C)
3803 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3804#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3805 needed += 2 /* hostname_len */
3806 + hostname_len; /* hostname */
3807#endif
3808
3809 needed += 4 /* ticket_lifetime */
3810 + 2; /* ticket_len */
3811
3812 /* Check size_t overflow */
3813 if (session->ticket_len > SIZE_MAX - needed) {
3814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3815 }
3816
3817 needed += session->ticket_len; /* ticket */
3818 }
3819#endif /* MBEDTLS_SSL_CLI_C */
3820
3821 *olen = needed;
3822 if (needed > buf_len) {
3823 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3824 }
3825
3826 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3827 p[4] = session->ticket_flags;
3828
3829 /* save resumption_key */
3830 p[5] = session->resumption_key_len;
3831 p += 6;
3832 memcpy(p, session->resumption_key, session->resumption_key_len);
3833 p += session->resumption_key_len;
3834
3835#if defined(MBEDTLS_SSL_EARLY_DATA)
3836 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3837 p += 4;
3838#endif
3839#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3840 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3841 p += 2;
3842#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3843
3844#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3845 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3846 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3847 p += 8;
3848 }
3849#endif /* MBEDTLS_HAVE_TIME */
3850
3851#if defined(MBEDTLS_SSL_CLI_C)
3852 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3853#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3854 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3855 p += 2;
3856 if (hostname_len > 0) {
3857 /* save host name */
3858 memcpy(p, session->hostname, hostname_len);
3859 p += hostname_len;
3860 }
3861#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3862
3863#if defined(MBEDTLS_HAVE_TIME)
3864 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3865 p += 8;
3866#endif
3867 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3868 p += 4;
3869
3870 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3871 p += 2;
3872
3873 if (session->ticket != NULL && session->ticket_len > 0) {
3874 memcpy(p, session->ticket, session->ticket_len);
3875 p += session->ticket_len;
3876 }
3877 }
3878#endif /* MBEDTLS_SSL_CLI_C */
3879 return 0;
3880}
3881
3882MBEDTLS_CHECK_RETURN_CRITICAL
3883static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3884 const unsigned char *buf,
3885 size_t len)
3886{
3887 const unsigned char *p = buf;
3888 const unsigned char *end = buf + len;
3889
3890 if (end - p < 6) {
3891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3892 }
3893 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3894 session->ticket_flags = p[4];
3895
3896 /* load resumption_key */
3897 session->resumption_key_len = p[5];
3898 p += 6;
3899
3900 if (end - p < session->resumption_key_len) {
3901 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3902 }
3903
3904 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3906 }
3907 memcpy(session->resumption_key, p, session->resumption_key_len);
3908 p += session->resumption_key_len;
3909
3910#if defined(MBEDTLS_SSL_EARLY_DATA)
3911 if (end - p < 4) {
3912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3913 }
3914 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3915 p += 4;
3916#endif
3917#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3918 if (end - p < 2) {
3919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3920 }
3921 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3922 p += 2;
3923#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3924
3925#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3926 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3927 if (end - p < 8) {
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929 }
3930 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3931 p += 8;
3932 }
3933#endif /* MBEDTLS_HAVE_TIME */
3934
3935#if defined(MBEDTLS_SSL_CLI_C)
3936 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3937#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3938 size_t hostname_len;
3939 /* load host name */
3940 if (end - p < 2) {
3941 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3942 }
3943 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3944 p += 2;
3945
3946 if (end - p < (long int) hostname_len) {
3947 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3948 }
3949 if (hostname_len > 0) {
3950 session->hostname = mbedtls_calloc(1, hostname_len);
3951 if (session->hostname == NULL) {
3952 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3953 }
3954 memcpy(session->hostname, p, hostname_len);
3955 p += hostname_len;
3956 }
3957#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3958
3959#if defined(MBEDTLS_HAVE_TIME)
3960 if (end - p < 8) {
3961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3962 }
3963 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3964 p += 8;
3965#endif
3966 if (end - p < 4) {
3967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3968 }
3969 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3970 p += 4;
3971
3972 if (end - p < 2) {
3973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
3975 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3976 p += 2;
3977
3978 if (end - p < (long int) session->ticket_len) {
3979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3980 }
3981 if (session->ticket_len > 0) {
3982 session->ticket = mbedtls_calloc(1, session->ticket_len);
3983 if (session->ticket == NULL) {
3984 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3985 }
3986 memcpy(session->ticket, p, session->ticket_len);
3987 p += session->ticket_len;
3988 }
3989 }
3990#endif /* MBEDTLS_SSL_CLI_C */
3991
3992 return 0;
3993
3994}
3995#else /* MBEDTLS_SSL_SESSION_TICKETS */
3996MBEDTLS_CHECK_RETURN_CRITICAL
3997static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3998 unsigned char *buf,
3999 size_t buf_len,
4000 size_t *olen)
4001{
4002 ((void) session);
4003 ((void) buf);
4004 ((void) buf_len);
4005 *olen = 0;
4006 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4007}
4008
4009static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4010 unsigned char *buf,
4011 size_t buf_len)
4012{
4013 ((void) session);
4014 ((void) buf);
4015 ((void) buf_len);
4016 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4017}
4018#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4019#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4020
Paul Bakker5121ce52009-01-03 21:22:43 +00004021/*
Hanno Beckera835da52019-05-16 12:39:07 +01004022 * Define ticket header determining Mbed TLS version
4023 * and structure of the ticket.
4024 */
4025
Hanno Becker94ef3b32019-05-16 12:50:45 +01004026/*
Hanno Becker50b59662019-05-28 14:30:45 +01004027 * Define bitflag determining compile-time settings influencing
4028 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004029 */
4030
Hanno Becker50b59662019-05-28 14:30:45 +01004031#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004032#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004033#else
Hanno Becker3e088662019-05-29 11:10:18 +01004034#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004035#endif /* MBEDTLS_HAVE_TIME */
4036
4037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004038#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004039#else
Hanno Becker3e088662019-05-29 11:10:18 +01004040#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004041#endif /* MBEDTLS_X509_CRT_PARSE_C */
4042
David Horstmann5c5a32f2024-02-13 17:53:35 +00004043#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4044#define SSL_SERIALIZED_SESSION_KEEP_PEER_CRT 1
4045#else
4046#define SSL_SERIALIZED_SESSION_KEEP_PEER_CRT 0
4047#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4048
Hanno Becker94ef3b32019-05-16 12:50:45 +01004049#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004050#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004051#else
Hanno Becker3e088662019-05-29 11:10:18 +01004052#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004053#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4054
4055#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004056#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004057#else
Hanno Becker3e088662019-05-29 11:10:18 +01004058#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004059#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4060
Hanno Becker94ef3b32019-05-16 12:50:45 +01004061#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004062#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004063#else
Hanno Becker3e088662019-05-29 11:10:18 +01004064#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004065#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4066
Hanno Becker94ef3b32019-05-16 12:50:45 +01004067#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4068#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4069#else
4070#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4071#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4072
David Horstmann92b258b2024-02-13 17:23:34 +00004073#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4074#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4075#else
4076#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4077#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4078
4079#if defined(MBEDTLS_SSL_EARLY_DATA)
4080#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4081#else
4082#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4083#endif /* MBEDTLS_SSL_EARLY_DATA */
4084
4085#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4086#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4087#else
4088#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4089#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4090
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4092#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4093#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4094#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004095#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4096#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmann5c5a32f2024-02-13 17:53:35 +00004097#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004098#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4099#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4100#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Hanno Becker3e088662019-05-29 11:10:18 +01004101
Hanno Becker50b59662019-05-28 14:30:45 +01004102#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 ((uint16_t) ( \
4104 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4105 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4106 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4107 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4108 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4109 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004110 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004111 (SSL_SERIALIZED_SESSION_KEEP_PEER_CRT << SSL_SERIALIZED_SESSION_CONFIG_KEEP_CRT_BIT) | \
4112 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4113 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4114 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4115 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
4116 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004117
Chien Wong4e9683e2023-12-28 17:07:43 +08004118static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004119 MBEDTLS_VERSION_MAJOR,
4120 MBEDTLS_VERSION_MINOR,
4121 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4123 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004124};
Hanno Beckera835da52019-05-16 12:39:07 +01004125
4126/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004127 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004128 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004129 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004130 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004131 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004132 * opaque mbedtls_version[3]; // library version: major, minor, patch
4133 * opaque session_format[2]; // library-version specific 16-bit field
4134 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004135 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004136 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004137 * Note: When updating the format, remember to keep
4138 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004139 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004140 * // In this version, `session_format` determines
4141 * // the setting of those compile-time
4142 * // configuration options which influence
4143 * // the structure of mbedtls_ssl_session.
4144 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004145 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004146 * // - TLS 1.2 (0x0303)
4147 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004148 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004149 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004150 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004151 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004152 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004153 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004154 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004155 *
4156 * };
4157 *
4158 * } serialized_session;
4159 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004160 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004161
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004162MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004163static int ssl_session_save(const mbedtls_ssl_session *session,
4164 unsigned char omit_header,
4165 unsigned char *buf,
4166 size_t buf_len,
4167 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004168{
4169 unsigned char *p = buf;
4170 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004171 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004172#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4173 size_t out_len;
4174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4175#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (session == NULL) {
4177 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4178 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004181 /*
4182 * Add Mbed TLS version identifier
4183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 if (used <= buf_len) {
4187 memcpy(p, ssl_serialized_session_header,
4188 sizeof(ssl_serialized_session_header));
4189 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004190 }
4191 }
4192
4193 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004194 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004195 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004196 used += 1 /* TLS version */
4197 + 1 /* endpoint */
4198 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 if (used <= buf_len) {
4200 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004201 *p++ = session->endpoint;
4202 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4203 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004204 }
4205
4206 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004207 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004209#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 case MBEDTLS_SSL_VERSION_TLS1_2:
4211 used += ssl_tls12_session_save(session, p, remaining_len);
4212 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004213#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4214
Jerry Yu251a12e2022-07-13 15:15:48 +08004215#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 case MBEDTLS_SSL_VERSION_TLS1_3:
4217 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4218 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4219 return ret;
4220 }
4221 used += out_len;
4222 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004223#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 default:
4226 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004227 }
4228
4229 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 if (used > buf_len) {
4231 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4232 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004235}
4236
4237/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004238 * Public wrapper for ssl_session_save()
4239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004240int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4241 unsigned char *buf,
4242 size_t buf_len,
4243 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004244{
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004246}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004247
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004248/*
4249 * Deserialize session, see mbedtls_ssl_session_save() for format.
4250 *
4251 * This internal version is wrapped by a public function that cleans up in
4252 * case of error, and has an extra option omit_header.
4253 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004254MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004255static int ssl_session_load(mbedtls_ssl_session *session,
4256 unsigned char omit_header,
4257 const unsigned char *buf,
4258 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004259{
4260 const unsigned char *p = buf;
4261 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004262 size_t remaining_len;
4263
4264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (session == NULL) {
4266 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4267 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004270 /*
4271 * Check Mbed TLS version identifier
4272 */
4273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004277
4278 if (memcmp(p, ssl_serialized_session_header,
4279 sizeof(ssl_serialized_session_header)) != 0) {
4280 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4281 }
4282 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004283 }
4284
4285 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004286 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004288 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4290 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004291 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004292 session->endpoint = *p++;
4293 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4294 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004295
4296 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004297 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004299#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 case MBEDTLS_SSL_VERSION_TLS1_2:
4301 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004302#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4303
Jerry Yu438ddd82022-07-07 06:55:50 +00004304#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 case MBEDTLS_SSL_VERSION_TLS1_3:
4306 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4308
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 default:
4310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004311 }
4312}
4313
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004314/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004315 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004316 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4318 const unsigned char *buf,
4319 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004320{
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (ret != 0) {
4324 mbedtls_ssl_session_free(session);
4325 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004328}
4329
4330/*
Paul Bakker1961b702013-01-25 14:49:24 +01004331 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004332 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004333MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004334static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004335{
4336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4337
Ronald Cron66dbf912022-02-02 15:33:46 +01004338 /*
4339 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004340 * that were written into the output buffer by the previous handshake step,
4341 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004342 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4343 * We proceed to the next handshake step only when all data from the
4344 * previous one have been sent to the peer, thus we make sure that this is
4345 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4346 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4347 * we have to wait before to go ahead.
4348 * In the case of TLS 1.3, handshake step handlers do not send data to the
4349 * peer. Data are only sent here and through
4350 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004351 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4354 return ret;
4355 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004356
4357#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4359 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4360 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4361 return ret;
4362 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004363 }
4364#endif /* MBEDTLS_SSL_PROTO_DTLS */
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004367}
4368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004370{
Hanno Becker41934dd2021-08-07 19:13:43 +01004371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004374 ssl->conf == NULL ||
4375 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4377 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004378 }
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 ret = ssl_prepare_handshake_step(ssl);
4381 if (ret != 0) {
4382 return ret;
4383 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 ret = mbedtls_ssl_handle_pending_alert(ssl);
4386 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004387 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 }
Jerry Yue7047812021-09-13 19:26:39 +08004389
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004390 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4391 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4392 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4396 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004397 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004400 case MBEDTLS_SSL_HELLO_REQUEST:
4401 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004402 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004403 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004404
Ronald Cron9f0fba32022-02-10 16:45:15 +01004405 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004407 break;
4408
4409 default:
4410#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4412 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4413 } else {
4414 ret = mbedtls_ssl_handshake_client_step(ssl);
4415 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004416#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004418#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004420#endif
4421 }
Jerry Yub9930e72021-08-06 17:11:51 +08004422 }
Ronald Cron6291b232023-03-08 15:51:25 +01004423#endif /* MBEDTLS_SSL_CLI_C */
4424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004425#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004427#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4428 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004430 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 ret = mbedtls_ssl_handshake_server_step(ssl);
4432 }
Ronald Cron6291b232023-03-08 15:51:25 +01004433#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4434 ret = mbedtls_ssl_handshake_server_step(ssl);
4435#else
4436 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004437#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004438 }
4439#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004442 /* handshake_step return error. And it is same
4443 * with alert_reason.
4444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (ssl->send_alert) {
4446 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004447 goto cleanup;
4448 }
4449 }
4450
4451cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004453}
4454
4455/*
4456 * Perform the SSL handshake
4457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004458int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004459{
4460 int ret = 0;
4461
Hanno Beckera817ea42020-10-20 15:20:23 +01004462 /* Sanity checks */
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (ssl == NULL || ssl->conf == NULL) {
4465 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4466 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004467
Hanno Beckera817ea42020-10-20 15:20:23 +01004468#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4470 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4471 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4472 "mbedtls_ssl_set_timer_cb() for DTLS"));
4473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004474 }
4475#endif /* MBEDTLS_SSL_PROTO_DTLS */
4476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004478
Hanno Beckera817ea42020-10-20 15:20:23 +01004479 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4481 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004484 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 }
Paul Bakker1961b702013-01-25 14:49:24 +01004486 }
4487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004491}
4492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004493#if defined(MBEDTLS_SSL_RENEGOTIATION)
4494#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004495/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004496 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004497 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004498MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004499static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004500{
Janos Follath865b3eb2019-12-16 11:46:15 +00004501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004504
4505 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4507 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4511 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004512 }
4513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004517}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004518#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004519
4520/*
4521 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004522 * - any side: calling mbedtls_ssl_renegotiate(),
4523 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4524 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004525 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004526 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004527 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004529int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004530{
Janos Follath865b3eb2019-12-16 11:46:15 +00004531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if ((ret = ssl_handshake_init(ssl)) != 0) {
4536 return ret;
4537 }
Paul Bakker48916f92012-09-16 19:57:18 +00004538
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004539 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4540 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4543 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4544 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004545 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004547 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004549 }
4550#endif
4551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004552 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4553 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4556 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4557 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004558 }
4559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004563}
4564
4565/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004566 * Renegotiate current connection on client,
4567 * or request renegotiation on server
4568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004569int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004570{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ssl == NULL || ssl->conf == NULL) {
4574 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4575 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004577#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004578 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4580 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4582 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004584 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004585
4586 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (ssl->out_left != 0) {
4588 return mbedtls_ssl_flush_output(ssl);
4589 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004592 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004593#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004596 /*
4597 * On client, either start the renegotiation process or,
4598 * if already in progress, continue the handshake
4599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4601 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004603 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004604
4605 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4606 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4607 return ret;
4608 }
4609 } else {
4610 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4611 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4612 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004613 }
4614 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004618}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004622{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004623 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004626 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004628
Valerio Setti6f0441d2023-07-03 12:11:36 +02004629#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004630#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (ssl->handshake->group_list_heap_allocated) {
4632 mbedtls_free((void *) handshake->group_list);
4633 }
Brett Warrene0edc842021-08-17 09:53:13 +01004634 handshake->group_list = NULL;
4635#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004636#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004637
Ronald Crone68ab4f2022-10-05 12:46:29 +02004638#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004639#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (ssl->handshake->sig_algs_heap_allocated) {
4641 mbedtls_free((void *) handshake->sig_algs);
4642 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004643 handshake->sig_algs = NULL;
4644#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004645#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (ssl->handshake->certificate_request_context) {
4647 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004648 }
4649#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004650#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004651
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004652#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4654 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004655 handshake->async_in_progress = 0;
4656 }
4657#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4658
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004659#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004660#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004662#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004663 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004664#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004665#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004666#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004669#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004670 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004671#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004672#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004674#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004676#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004677#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004678 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004680#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004681
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004682#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004683#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004685 /*
4686 * Opaque keys are not stored in the handshake's data and it's the user
4687 * responsibility to destroy them. Clear ones, instead, are created by
4688 * the TLS library and should be destroyed at the same level
4689 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4691 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004692 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004693 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4694#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004696#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004697#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004699 handshake->ecjpake_cache = NULL;
4700 handshake->ecjpake_cache_len = 0;
4701#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004702#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004703
Valerio Setti7aeec542023-07-05 18:57:21 +02004704#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004705 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004706 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004707 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004709#endif
4710
Ronald Cron73fe8df2022-10-05 14:31:43 +02004711#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004712#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004714 /* The maintenance of the external PSK key slot is the
4715 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (ssl->handshake->psk_opaque_is_internal) {
4717 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004718 ssl->handshake->psk_opaque_is_internal = 0;
4719 }
4720 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4721 }
Neil Armstronge952a302022-05-03 10:22:14 +02004722#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004724 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004725 }
Neil Armstronge952a302022-05-03 10:22:14 +02004726#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004727#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4730 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004731 /*
4732 * Free only the linked list wrapper, not the keys themselves
4733 * since the belong to the SNI callback
4734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004737
Gilles Peskineeccd8882020-03-10 12:19:08 +01004738#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4740 if (handshake->ecrs_peer_cert != NULL) {
4741 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4742 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004743 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004744#endif
4745
Hanno Becker75173122019-02-06 16:18:31 +00004746#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4747 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004749#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4750
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004751#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4753 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004754#endif /* MBEDTLS_SSL_CLI_C &&
4755 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004756
4757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 mbedtls_ssl_flight_free(handshake->flight);
4759 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004760#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004761
Valerio Settiea59c432023-07-25 11:14:03 +02004762#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004763 if (handshake->xxdh_psa_privkey_is_external == 0) {
4764 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 }
Valerio Settiea59c432023-07-25 11:14:03 +02004766#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004767
Ronald Cron6f135e12021-12-08 16:57:54 +01004768#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 mbedtls_ssl_transform_free(handshake->transform_handshake);
4770 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004771#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4773 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004774#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004775#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004776
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004777
4778#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4779 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4780 * processes datagrams and the fact that a datagram is allowed to have
4781 * several records in it, it is possible that the I/O buffers are not
4782 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4784 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004785#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004786
Jerry Yuba9c7272021-10-30 11:54:10 +08004787 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 mbedtls_platform_zeroize(handshake,
4789 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004790}
4791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004793{
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004795 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004800#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004801
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004802#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004803#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4804 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004806#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004808#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004811}
4812
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004813#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004814
4815#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4816#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4817#else
4818#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4819#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4820
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004821#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004822
4823#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4824#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4825#else
4826#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4827#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4828
4829#if defined(MBEDTLS_SSL_ALPN)
4830#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4831#else
4832#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4833#endif /* MBEDTLS_SSL_ALPN */
4834
4835#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4836#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4837#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4838#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4839
4840#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 ((uint32_t) ( \
4842 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4843 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4844 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4845 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4846 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4847 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4848 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4849 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004850
Chien Wong4e9683e2023-12-28 17:07:43 +08004851static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004852 MBEDTLS_VERSION_MAJOR,
4853 MBEDTLS_VERSION_MINOR,
4854 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4856 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4857 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4858 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4859 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004860};
4861
Paul Bakker5121ce52009-01-03 21:22:43 +00004862/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004863 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004864 *
4865 * The format of the serialized data is:
4866 * (in the presentation language of TLS, RFC 8446 section 3)
4867 *
4868 * // header
4869 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004870 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004871 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004872 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004873 * Note: When updating the format, remember to keep these
4874 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004875 *
4876 * // session sub-structure
4877 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4878 * // transform sub-structure
4879 * uint8 random[64]; // ServerHello.random+ClientHello.random
4880 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4881 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4882 * // fields from ssl_context
4883 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4884 * uint64 in_window_top; // DTLS: last validated record seq_num
4885 * uint64 in_window; // DTLS: bitmask for replay protection
4886 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4887 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4888 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4889 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4890 *
4891 * Note that many fields of the ssl_context or sub-structures are not
4892 * serialized, as they fall in one of the following categories:
4893 *
4894 * 1. forced value (eg in_left must be 0)
4895 * 2. pointer to dynamically-allocated memory (eg session, transform)
4896 * 3. value can be re-derived from other data (eg session keys from MS)
4897 * 4. value was temporary (eg content of input buffer)
4898 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4901 unsigned char *buf,
4902 size_t buf_len,
4903 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004904{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004905 unsigned char *p = buf;
4906 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004907 size_t session_len;
4908 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004909
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004910 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004911 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4912 * this function's documentation.
4913 *
4914 * These are due to assumptions/limitations in the implementation. Some of
4915 * them are likely to stay (no handshake in progress) some might go away
4916 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004917 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004918 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4920 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4921 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004922 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (ssl->handshake != NULL) {
4924 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4925 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004926 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004927 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (ssl->transform == NULL || ssl->session == NULL) {
4929 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4930 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004931 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004932 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (mbedtls_ssl_check_pending(ssl) != 0) {
4934 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004936 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 if (ssl->out_left != 0) {
4938 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004940 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004941 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4943 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4944 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004945 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004946 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4948 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004950 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004951 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4953 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004955 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004956 /* Renegotiation must not be enabled */
4957#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4959 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4960 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004961 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004962#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004963
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004964 /*
4965 * Version and format identifier
4966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (used <= buf_len) {
4970 memcpy(p, ssl_serialized_context_header,
4971 sizeof(ssl_serialized_context_header));
4972 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004973 }
4974
4975 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004976 * Session (length + data)
4977 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4979 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4980 return ret;
4981 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004982
4983 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (used <= buf_len) {
4985 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004986 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 ret = ssl_session_save(ssl->session, 1,
4989 p, session_len, &session_len);
4990 if (ret != 0) {
4991 return ret;
4992 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004993
4994 p += session_len;
4995 }
4996
4997 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004998 * Transform
4999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 used += sizeof(ssl->transform->randbytes);
5001 if (used <= buf_len) {
5002 memcpy(p, ssl->transform->randbytes,
5003 sizeof(ssl->transform->randbytes));
5004 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005005 }
5006
5007#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005008 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005010 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005012 p += ssl->transform->in_cid_len;
5013
5014 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005016 p += ssl->transform->out_cid_len;
5017 }
5018#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5019
5020 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005021 * Saved fields from top-level ssl_context structure
5022 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005023 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if (used <= buf_len) {
5025 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005026 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005027 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005028
5029#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5030 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 if (used <= buf_len) {
5032 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005033 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005036 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005037 }
5038#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5039
5040#if defined(MBEDTLS_SSL_PROTO_DTLS)
5041 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005043 *p++ = ssl->disable_datagram_packing;
5044 }
5045#endif /* MBEDTLS_SSL_PROTO_DTLS */
5046
Jerry Yuae0b2e22021-10-08 15:21:19 +08005047 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (used <= buf_len) {
5049 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005050 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005051 }
5052
5053#if defined(MBEDTLS_SSL_PROTO_DTLS)
5054 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (used <= buf_len) {
5056 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005057 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005058 }
5059#endif /* MBEDTLS_SSL_PROTO_DTLS */
5060
5061#if defined(MBEDTLS_SSL_ALPN)
5062 {
5063 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005065 : 0;
5066
5067 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005069 *p++ = alpn_len;
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (ssl->alpn_chosen != NULL) {
5072 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073 p += alpn_len;
5074 }
5075 }
5076 }
5077#endif /* MBEDTLS_SSL_ALPN */
5078
5079 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005080 * Done
5081 */
5082 *olen = used;
5083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (used > buf_len) {
5085 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5086 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005091}
5092
5093/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005094 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005095 *
5096 * This internal version is wrapped by a public function that cleans up in
5097 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005098 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005100static int ssl_context_load(mbedtls_ssl_context *ssl,
5101 const unsigned char *buf,
5102 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005103{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005104 const unsigned char *p = buf;
5105 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005106 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005108#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005109 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005110#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005111
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005112 /*
5113 * The context should have been freshly setup or reset.
5114 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005115 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005116 * renegotiating, or if the user mistakenly loaded a session first.)
5117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5119 ssl->session != NULL) {
5120 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005121 }
5122
5123 /*
5124 * We can't check that the config matches the initial one, but we can at
5125 * least check it matches the requirements for serializing.
5126 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005127 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005128#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005129 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005130#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005131 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5132 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5133 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5134 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005136 }
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005139
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005140 /*
5141 * Check version identifier
5142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5144 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005145 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005146
5147 if (memcmp(p, ssl_serialized_context_header,
5148 sizeof(ssl_serialized_context_header)) != 0) {
5149 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5150 }
5151 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005152
5153 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005154 * Session
5155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if ((size_t) (end - p) < 4) {
5157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5158 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005159
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005160 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005161 p += 4;
5162
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005163 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005164 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005165 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005166 ssl->session_in = ssl->session;
5167 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005168 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005169
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if ((size_t) (end - p) < session_len) {
5171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5172 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 ret = ssl_session_load(ssl->session, 1, p, session_len);
5175 if (ret != 0) {
5176 mbedtls_ssl_session_free(ssl->session);
5177 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005178 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005179
5180 p += session_len;
5181
5182 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005183 * Transform
5184 */
5185
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005186 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005187 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005188#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005189 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005190 ssl->transform_in = ssl->transform;
5191 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005192 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005193#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005194
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005195#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5197 if (prf_func == NULL) {
5198 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5199 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005200
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005201 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5203 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5204 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 ret = ssl_tls12_populate_transform(ssl->transform,
5207 ssl->session->ciphersuite,
5208 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005209#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005211#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 prf_func,
5213 p, /* currently pointing to randbytes */
5214 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5215 ssl->conf->endpoint,
5216 ssl);
5217 if (ret != 0) {
5218 return ret;
5219 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005220#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005222
5223#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5224 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 if ((size_t) (end - p) < 1) {
5226 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5227 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005228
5229 ssl->transform->in_cid_len = *p++;
5230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5233 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005236 p += ssl->transform->in_cid_len;
5237
5238 ssl->transform->out_cid_len = *p++;
5239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5242 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005245 p += ssl->transform->out_cid_len;
5246#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5247
5248 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005249 * Saved fields from top-level ssl_context structure
5250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if ((size_t) (end - p) < 4) {
5252 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5253 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005254
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005255 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005256 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005257
5258#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if ((size_t) (end - p) < 16) {
5260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5261 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005262
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005263 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005264 p += 8;
5265
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005266 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005267 p += 8;
5268#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5269
5270#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if ((size_t) (end - p) < 1) {
5272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5273 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005274
5275 ssl->disable_datagram_packing = *p++;
5276#endif /* MBEDTLS_SSL_PROTO_DTLS */
5277
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5280 }
5281 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5282 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005283
5284#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if ((size_t) (end - p) < 2) {
5286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5287 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005288
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005289 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005290 p += 2;
5291#endif /* MBEDTLS_SSL_PROTO_DTLS */
5292
5293#if defined(MBEDTLS_SSL_ALPN)
5294 {
5295 uint8_t alpn_len;
5296 const char **cur;
5297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if ((size_t) (end - p) < 1) {
5299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5300 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005301
5302 alpn_len = *p++;
5303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005305 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5307 if (strlen(*cur) == alpn_len &&
5308 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005309 ssl->alpn_chosen = *cur;
5310 break;
5311 }
5312 }
5313 }
5314
5315 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5318 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005319
5320 p += alpn_len;
5321 }
5322#endif /* MBEDTLS_SSL_ALPN */
5323
5324 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005325 * Forced fields from top-level ssl_context structure
5326 *
5327 * Most of them already set to the correct value by mbedtls_ssl_init() and
5328 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5329 */
5330 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005331 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005332
Hanno Becker361b10d2019-08-30 10:42:49 +01005333 /* Adjust pointers for header fields of outgoing records to
5334 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005336
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005337#if defined(MBEDTLS_SSL_PROTO_DTLS)
5338 ssl->in_epoch = 1;
5339#endif
5340
5341 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5342 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005343 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5344 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (ssl->handshake != NULL) {
5346 mbedtls_ssl_handshake_free(ssl);
5347 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005348 ssl->handshake = NULL;
5349 }
5350
5351 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005352 * Done - should have consumed entire buffer
5353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if (p != end) {
5355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5356 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005357
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005359}
5360
5361/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005362 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005364int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5365 const unsigned char *buf,
5366 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005367{
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005369
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 if (ret != 0) {
5371 mbedtls_ssl_free(context);
5372 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005375}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005377
5378/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005379 * Free an SSL context
5380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005382{
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005384 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005388
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005390#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5391 size_t out_buf_len = ssl->out_buf_len;
5392#else
5393 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5394#endif
5395
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005396 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005397 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005398 }
5399
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005401#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5402 size_t in_buf_len = ssl->in_buf_len;
5403#else
5404 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5405#endif
5406
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005407 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005408 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005409 }
5410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if (ssl->transform) {
5412 mbedtls_ssl_transform_free(ssl->transform);
5413 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005414 }
5415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (ssl->handshake) {
5417 mbedtls_ssl_handshake_free(ssl);
5418 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005419
5420#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5422 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005423#endif
5424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 mbedtls_ssl_session_free(ssl->session_negotiate);
5426 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005427 }
5428
Ronald Cron6f135e12021-12-08 16:57:54 +01005429#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 mbedtls_ssl_transform_free(ssl->transform_application);
5431 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005433
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 if (ssl->session) {
5435 mbedtls_ssl_session_free(ssl->session);
5436 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005437 }
5438
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005439#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005441 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005442 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005443#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005444
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005445#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005447#endif
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005450
Paul Bakker86f04f42013-02-14 11:20:09 +01005451 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005453}
5454
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005455/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005456 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005458void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005459{
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005461}
5462
Gilles Peskineae270bf2021-06-02 00:05:29 +02005463/* The selection should be the same as mbedtls_x509_crt_profile_default in
5464 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005465 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005466 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005467 * about this list.
5468 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005469static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005470#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005471 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005472#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005473#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005474 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005475#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005476#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005477 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005478#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005479#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005480 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005481#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005482#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005483 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005484#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005485#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005486 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005487#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005488#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005489 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005490#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005491#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005492 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005493#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005494#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005495 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5496 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5497 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5498 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5499 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5500#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005501 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005502};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005503
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005504static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005505 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5506 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5507 0
5508};
5509
Ronald Crone68ab4f2022-10-05 12:46:29 +02005510#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005511
Jerry Yu909df7b2022-01-22 11:56:27 +08005512/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005513 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005514 * rules SHOULD be upheld.
5515 * - No duplicate entries.
5516 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005517 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005518 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005519 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005520static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005521
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005522#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005523 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005524 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005525 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005526 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5527#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005528
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005529#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005530 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005531 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005532 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005533 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5534#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005535
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005536#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005537 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005538 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005539 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005540 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5541#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005542
Yanray Wang1136fad2023-11-22 16:54:31 +08005543#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005544 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005545#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005546
Yanray Wang1136fad2023-11-22 16:54:31 +08005547#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005548 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005549#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005550
Yanray Wang1136fad2023-11-22 16:54:31 +08005551#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005552 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005553#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005554
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005555#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005556 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005557#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005558
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005559#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005560 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005561#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005562
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005563#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005564 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005565#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005566
Gabor Mezei15b95a62022-05-09 16:37:58 +02005567 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005568};
5569
5570/* NOTICE: see above */
5571#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5572static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005573
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005574#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005575#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005577#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005578#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5579 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005580#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005581#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005583#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005584#endif /* MBEDTLS_MD_CAN_SHA512 */
5585
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005586#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005587#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005589#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005590#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5591 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005592#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005593#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005595#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005596#endif /* MBEDTLS_MD_CAN_SHA384 */
5597
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005598#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005599#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005601#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005602#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5603 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005604#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005605#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005607#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005608#endif /* MBEDTLS_MD_CAN_SHA256 */
5609
Gabor Mezei15b95a62022-05-09 16:37:58 +02005610 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005611};
5612#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005613
Jerry Yu909df7b2022-01-22 11:56:27 +08005614/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005615static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005616
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005617#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005618 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005619 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005620 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005621 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5622#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005623
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005624#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005625 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005626 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005627 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005628 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5629#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005630
Gabor Mezei15b95a62022-05-09 16:37:58 +02005631 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005632};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005633
Jerry Yu909df7b2022-01-22 11:56:27 +08005634/* NOTICE: see above */
5635#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5636static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005637
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005638#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005639#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005641#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005642#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005643
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005644#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005645#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005647#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005648#endif /* MBEDTLS_MD_CAN_SHA384 */
5649
Gabor Mezei15b95a62022-05-09 16:37:58 +02005650 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005651};
Jerry Yu909df7b2022-01-22 11:56:27 +08005652#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5653
Ronald Crone68ab4f2022-10-05 12:46:29 +02005654#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005655
Chien Wong4e9683e2023-12-28 17:07:43 +08005656static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005658 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005659#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005660#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005661 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005662#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005663 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005664};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005665
Ronald Crone68ab4f2022-10-05 12:46:29 +02005666#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005667/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005668 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005669MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005670static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005671{
5672 size_t i, j;
5673 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005674
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5676 for (j = 0; j < i; j++) {
5677 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005678 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 }
5680 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5681 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5682 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005683 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005684 }
5685 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005687}
5688
Ronald Crone68ab4f2022-10-05 12:46:29 +02005689#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005690
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005691/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005692 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005694int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5695 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005696{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005697#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005699#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005700
Ronald Crone68ab4f2022-10-05 12:46:29 +02005701#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5703 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5704 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005705 }
5706
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5708 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5709 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005710 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005711
5712#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5714 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5715 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005716 }
5717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5719 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5720 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005721 }
5722#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005723#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005724
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005725 /* Use the functions here so that they are covered in tests,
5726 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 mbedtls_ssl_conf_endpoint(conf, endpoint);
5728 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005729
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005730 /*
5731 * Things that are common to all presets
5732 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005733#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005735 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5736#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5737 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5738#endif
5739 }
5740#endif
5741
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005742#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5743 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5744#endif
5745
5746#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5747 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5748#endif
5749
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005750#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005751 conf->f_cookie_write = ssl_cookie_write_dummy;
5752 conf->f_cookie_check = ssl_cookie_check_dummy;
5753#endif
5754
5755#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5756 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5757#endif
5758
Janos Follath088ce432017-04-10 12:42:31 +01005759#if defined(MBEDTLS_SSL_SRV_C)
5760 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005761 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005762#endif
5763
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005764#if defined(MBEDTLS_SSL_PROTO_DTLS)
5765 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5766 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5767#endif
5768
5769#if defined(MBEDTLS_SSL_RENEGOTIATION)
5770 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 memset(conf->renego_period, 0x00, 2);
5772 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005773#endif
5774
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005775#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005777 const unsigned char dhm_p[] =
5778 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5779 const unsigned char dhm_g[] =
5780 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005781
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5783 dhm_p, sizeof(dhm_p),
5784 dhm_g, sizeof(dhm_g))) != 0) {
5785 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005786 }
5787 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005788#endif
5789
Ronald Cron6f135e12021-12-08 16:57:54 +01005790#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005791
5792#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005793 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005794#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005795 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005796#endif
5797#endif /* MBEDTLS_SSL_EARLY_DATA */
5798
Jerry Yud0766ec2022-09-22 10:46:57 +08005799#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005800 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005802#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005803 /*
5804 * Allow all TLS 1.3 key exchange modes by default.
5805 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005806 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005807#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005808
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005810#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005811 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005812 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005813#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005815#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005817#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005818 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5819 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005820#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5821 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5822 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5823#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5824 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5825 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5826#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005828#endif
5829 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005830
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005831 /*
5832 * Preset-specific defaults
5833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005835 /*
5836 * NSA Suite B
5837 */
5838 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005839
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005840 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005841
5842#if defined(MBEDTLS_X509_CRT_PARSE_C)
5843 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005844#endif
5845
Ronald Crone68ab4f2022-10-05 12:46:29 +02005846#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005847#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005849 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005851#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005853#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005854
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005855#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005856 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005857#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005858 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005859 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005860
5861 /*
5862 * Default
5863 */
5864 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005865
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005866 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005867
5868#if defined(MBEDTLS_X509_CRT_PARSE_C)
5869 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5870#endif
5871
Ronald Crone68ab4f2022-10-05 12:46:29 +02005872#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005875 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005877#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005879#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005880
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005881#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005882 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005883#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005884 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005885
5886#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5887 conf->dhm_min_bitlen = 1024;
5888#endif
5889 }
5890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005892}
5893
5894/*
5895 * Free mbedtls_ssl_config
5896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005897void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005898{
5899#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 mbedtls_mpi_free(&conf->dhm_P);
5901 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005902#endif
5903
Ronald Cron73fe8df2022-10-05 14:31:43 +02005904#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005905#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005907 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5908 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005909#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005911 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005912 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005913 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005914 }
5915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005917 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005918 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005919 conf->psk_identity_len = 0;
5920 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005921#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005922
5923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005925#endif
5926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005928}
5929
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005930#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005931 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005932/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005933 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005935unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005936{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005937#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5939 return MBEDTLS_SSL_SIG_RSA;
5940 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005941#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005942#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5944 return MBEDTLS_SSL_SIG_ECDSA;
5945 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005946#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005948}
5949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005951{
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005953 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005955 case MBEDTLS_PK_ECDSA:
5956 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005958 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005960 }
5961}
5962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005964{
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005966#if defined(MBEDTLS_RSA_C)
5967 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005969#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005970#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005971 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005973#endif
5974 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005976 }
5977}
Valerio Settie9646ec2023-08-02 20:02:28 +02005978#endif /* MBEDTLS_PK_C &&
5979 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005980
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005981/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005982 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005983 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005984mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005985{
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005987#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005988 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005990#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005991#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005992 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005994#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005995#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005996 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005998#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005999#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006000 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006002#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006003#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006004 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006006#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006007#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006008 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006010#endif
6011 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006013 }
6014}
6015
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006016/*
6017 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006019unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006020{
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006022#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006023 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006025#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006026#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006027 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006029#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006030#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006031 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006033#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006034#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006035 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006037#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006038#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006039 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006041#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006042#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006043 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006045#endif
6046 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006048 }
6049}
6050
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006051/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006052 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006053 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006055int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006056{
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 if (group_list == NULL) {
6060 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006061 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 for (; *group_list != 0; group_list++) {
6064 if (*group_list == tls_id) {
6065 return 0;
6066 }
6067 }
6068
6069 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006070}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006071
Valerio Setti49e69072023-06-27 17:27:51 +02006072#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006073/*
6074 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6075 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006076int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006077{
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006081 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006085}
Valerio Setti49e69072023-06-27 17:27:51 +02006086#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006087
Valerio Setti18c9fed2022-12-30 17:44:24 +01006088static const struct {
6089 uint16_t tls_id;
6090 mbedtls_ecp_group_id ecp_group_id;
6091 psa_ecc_family_t psa_family;
6092 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006093} tls_id_match_table[] =
6094{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006095#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006096 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006097#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006098#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006099 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006100#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006101#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006102 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006103#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006104#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006105 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006106#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006107#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006108 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006109#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006110#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006111 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006112#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006113#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006114 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006115#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006116#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006117 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006118#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006119#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006120 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006121#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006122#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006123 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006124#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006125#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006126 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006127#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006128#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006129 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006130#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006131#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006132 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006133#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006134 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006135};
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006138 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006140{
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6142 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006143 if (type != NULL) {
6144 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 }
6146 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006147 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006149 return PSA_SUCCESS;
6150 }
6151 }
6152
6153 return PSA_ERROR_NOT_SUPPORTED;
6154}
6155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006157{
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6159 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006160 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006162 }
6163
6164 return MBEDTLS_ECP_DP_NONE;
6165}
6166
Gilles Peskine449bd832023-01-11 14:50:10 +01006167uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006168{
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6170 i++) {
6171 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006172 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006174 }
6175
6176 return 0;
6177}
6178
Valerio Setti67419f02023-01-04 16:12:42 +01006179#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006180static const struct {
6181 uint16_t tls_id;
6182 const char *name;
6183} tls_id_curve_name_table[] =
6184{
Valerio Setti54e23792023-07-07 10:49:27 +02006185 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6186 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6187 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6188 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6189 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6190 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6191 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6192 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6193 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6194 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6195 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6196 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6197 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006198 { 0, NULL },
6199};
6200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006202{
Valerio Settiacd32c02023-06-29 18:06:29 +02006203 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6204 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6205 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006207 }
6208
6209 return NULL;
6210}
Valerio Setti67419f02023-01-04 16:12:42 +01006211#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006213#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006214int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6215 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6216 int cert_endpoint,
6217 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006218{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006219 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006220 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006221 const char *ext_oid;
6222 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006223
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006225 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006227 case MBEDTLS_KEY_EXCHANGE_RSA:
6228 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006229 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006230 break;
6231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006232 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6233 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6234 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6235 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006236 break;
6237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006238 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6239 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006240 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006241 break;
6242
6243 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006244 case MBEDTLS_KEY_EXCHANGE_NONE:
6245 case MBEDTLS_KEY_EXCHANGE_PSK:
6246 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6247 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006248 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006249 usage = 0;
6250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006252 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6253 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006254 }
6255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006257 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006258 ret = -1;
6259 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006262 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6264 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006265 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006267 }
6268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006270 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006271 ret = -1;
6272 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006275}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006277
Jerry Yu148165c2021-09-24 23:20:59 +08006278#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006279int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6280 const mbedtls_md_type_t md,
6281 unsigned char *dst,
6282 size_t dst_len,
6283 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006284{
Ronald Cronf6893e12022-01-07 22:09:01 +01006285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6286 psa_hash_operation_t *hash_operation_to_clone;
6287 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6288
Jerry Yu148165c2021-09-24 23:20:59 +08006289 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006292#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 case MBEDTLS_MD_SHA384:
6294 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6295 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006296#endif
6297
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006298#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 case MBEDTLS_MD_SHA256:
6300 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6301 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006302#endif
6303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 default:
6305 goto exit;
6306 }
6307
6308 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6309 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006310 goto exit;
6311 }
6312
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6314 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006317
6318exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006319#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6320 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006321 (void) ssl;
6322#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006323 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006324}
6325#else /* MBEDTLS_USE_PSA_CRYPTO */
6326
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006327#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006328MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006329static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6330 unsigned char *dst,
6331 size_t dst_len,
6332 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006333{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006334 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006335 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006336
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (dst_len < 48) {
6338 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6339 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006340
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006341 mbedtls_md_init(&sha384);
6342 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006343 if (ret != 0) {
6344 goto exit;
6345 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006346 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006347 if (ret != 0) {
6348 goto exit;
6349 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006350
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006351 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006352 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006353 goto exit;
6354 }
6355
6356 *olen = 48;
6357
6358exit:
6359
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006360 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006362}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006363#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006364
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006365#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006366MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006367static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6368 unsigned char *dst,
6369 size_t dst_len,
6370 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006371{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006372 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006373 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (dst_len < 32) {
6376 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6377 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006378
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006379 mbedtls_md_init(&sha256);
6380 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6381 if (ret != 0) {
6382 goto exit;
6383 }
6384 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6385 if (ret != 0) {
6386 goto exit;
6387 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006388
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006389 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006391 goto exit;
6392 }
6393
6394 *olen = 32;
6395
6396exit:
6397
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006398 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006400}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006401#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006402
Gilles Peskine449bd832023-01-11 14:50:10 +01006403int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6404 const mbedtls_md_type_t md,
6405 unsigned char *dst,
6406 size_t dst_len,
6407 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006408{
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006410
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006411#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 case MBEDTLS_MD_SHA384:
6413 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006414#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006415
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006416#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 case MBEDTLS_MD_SHA256:
6418 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006419#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006422#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6423 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 (void) ssl;
6425 (void) dst;
6426 (void) dst_len;
6427 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006428#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006430 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006432}
XiaokangQian647719a2021-12-07 09:16:29 +00006433
Jerry Yu148165c2021-09-24 23:20:59 +08006434#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006435
Ronald Crone68ab4f2022-10-05 12:46:29 +02006436#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006437/* mbedtls_ssl_parse_sig_alg_ext()
6438 *
6439 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6440 * value (TLS 1.3 RFC8446):
6441 * enum {
6442 * ....
6443 * ecdsa_secp256r1_sha256( 0x0403 ),
6444 * ecdsa_secp384r1_sha384( 0x0503 ),
6445 * ecdsa_secp521r1_sha512( 0x0603 ),
6446 * ....
6447 * } SignatureScheme;
6448 *
6449 * struct {
6450 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6451 * } SignatureSchemeList;
6452 *
6453 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6454 * value (TLS 1.2 RFC5246):
6455 * enum {
6456 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6457 * sha512(6), (255)
6458 * } HashAlgorithm;
6459 *
6460 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6461 * SignatureAlgorithm;
6462 *
6463 * struct {
6464 * HashAlgorithm hash;
6465 * SignatureAlgorithm signature;
6466 * } SignatureAndHashAlgorithm;
6467 *
6468 * SignatureAndHashAlgorithm
6469 * supported_signature_algorithms<2..2^16-2>;
6470 *
6471 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6472 * generalization of the TLS 1.2 signature algorithm extension.
6473 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6474 * `SignatureScheme` field of TLS 1.3
6475 *
6476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006477int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6478 const unsigned char *buf,
6479 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006480{
6481 const unsigned char *p = buf;
6482 size_t supported_sig_algs_len = 0;
6483 const unsigned char *supported_sig_algs_end;
6484 uint16_t sig_alg;
6485 uint32_t common_idx = 0;
6486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6488 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006489 p += 2;
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 memset(ssl->handshake->received_sig_algs, 0,
6492 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006495 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 while (p < supported_sig_algs_end) {
6497 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6498 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006499 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6501 sig_alg,
6502 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006503#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6505 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6506 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006507 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006508 }
6509#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6512 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006515 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6516 common_idx += 1;
6517 }
6518 }
6519 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 if (p != end) {
6521 MBEDTLS_SSL_DEBUG_MSG(1,
6522 ("Signature algorithms extension length misaligned"));
6523 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6524 MBEDTLS_ERR_SSL_DECODE_ERROR);
6525 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006526 }
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 if (common_idx == 0) {
6529 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6530 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6531 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6532 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006533 }
6534
Gabor Mezei15b95a62022-05-09 16:37:58 +02006535 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006537}
6538
Ronald Crone68ab4f2022-10-05 12:46:29 +02006539#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006540
Jerry Yudc7bd172022-02-17 13:44:15 +08006541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6542
6543#if defined(MBEDTLS_USE_PSA_CRYPTO)
6544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6546 mbedtls_svc_key_id_t key,
6547 psa_algorithm_t alg,
6548 const unsigned char *raw_psk, size_t raw_psk_length,
6549 const unsigned char *seed, size_t seed_length,
6550 const unsigned char *label, size_t label_length,
6551 const unsigned char *other_secret,
6552 size_t other_secret_length,
6553 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006554{
6555 psa_status_t status;
6556
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 status = psa_key_derivation_setup(derivation, alg);
6558 if (status != PSA_SUCCESS) {
6559 return status;
6560 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6563 status = psa_key_derivation_input_bytes(derivation,
6564 PSA_KEY_DERIVATION_INPUT_SEED,
6565 seed, seed_length);
6566 if (status != PSA_SUCCESS) {
6567 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006568 }
6569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 if (other_secret != NULL) {
6571 status = psa_key_derivation_input_bytes(derivation,
6572 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6573 other_secret, other_secret_length);
6574 if (status != PSA_SUCCESS) {
6575 return status;
6576 }
6577 }
6578
6579 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006580 status = psa_key_derivation_input_bytes(
6581 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 raw_psk, raw_psk_length);
6583 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006584 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006586 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (status != PSA_SUCCESS) {
6588 return status;
6589 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 status = psa_key_derivation_input_bytes(derivation,
6592 PSA_KEY_DERIVATION_INPUT_LABEL,
6593 label, label_length);
6594 if (status != PSA_SUCCESS) {
6595 return status;
6596 }
6597 } else {
6598 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006599 }
6600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 status = psa_key_derivation_set_capacity(derivation, capacity);
6602 if (status != PSA_SUCCESS) {
6603 return status;
6604 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006607}
6608
Andrzej Kurek57d10632022-10-24 10:32:01 -04006609#if defined(PSA_WANT_ALG_SHA_384) || \
6610 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006612static int tls_prf_generic(mbedtls_md_type_t md_type,
6613 const unsigned char *secret, size_t slen,
6614 const char *label,
6615 const unsigned char *random, size_t rlen,
6616 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006617{
6618 psa_status_t status;
6619 psa_algorithm_t alg;
6620 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6621 psa_key_derivation_operation_t derivation =
6622 PSA_KEY_DERIVATION_OPERATION_INIT;
6623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006625 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006627 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006629
6630 /* Normally a "secret" should be long enough to be impossible to
6631 * find by brute force, and in particular should not be empty. But
6632 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6633 * and for this use case it makes sense to have a 0-length "secret".
6634 * Since the key API doesn't allow importing a key of length 0,
6635 * keep master_key=0, which setup_psa_key_derivation() understands
6636 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006638 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6640 psa_set_key_algorithm(&key_attributes, alg);
6641 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6644 if (status != PSA_SUCCESS) {
6645 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6646 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006647 }
6648
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 status = setup_psa_key_derivation(&derivation,
6650 master_key, alg,
6651 NULL, 0,
6652 random, rlen,
6653 (unsigned char const *) label,
6654 (size_t) strlen(label),
6655 NULL, 0,
6656 dlen);
6657 if (status != PSA_SUCCESS) {
6658 psa_key_derivation_abort(&derivation);
6659 psa_destroy_key(master_key);
6660 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006661 }
6662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6664 if (status != PSA_SUCCESS) {
6665 psa_key_derivation_abort(&derivation);
6666 psa_destroy_key(master_key);
6667 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006668 }
6669
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 status = psa_key_derivation_abort(&derivation);
6671 if (status != PSA_SUCCESS) {
6672 psa_destroy_key(master_key);
6673 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006674 }
6675
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 if (!mbedtls_svc_key_id_is_null(master_key)) {
6677 status = psa_destroy_key(master_key);
6678 }
6679 if (status != PSA_SUCCESS) {
6680 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6681 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006684}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006685#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006686#else /* MBEDTLS_USE_PSA_CRYPTO */
6687
Andrzej Kurek57d10632022-10-24 10:32:01 -04006688#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006689 (defined(MBEDTLS_MD_CAN_SHA256) || \
6690 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006692static int tls_prf_generic(mbedtls_md_type_t md_type,
6693 const unsigned char *secret, size_t slen,
6694 const char *label,
6695 const unsigned char *random, size_t rlen,
6696 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006697{
6698 size_t nb;
6699 size_t i, j, k, md_len;
6700 unsigned char *tmp;
6701 size_t tmp_len = 0;
6702 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6703 const mbedtls_md_info_t *md_info;
6704 mbedtls_md_context_t md_ctx;
6705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6710 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6711 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006712
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 tmp_len = md_len + strlen(label) + rlen;
6716 tmp = mbedtls_calloc(1, tmp_len);
6717 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006718 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6719 goto exit;
6720 }
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 nb = strlen(label);
6723 memcpy(tmp + md_len, label, nb);
6724 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006725 nb += rlen;
6726
6727 /*
6728 * Compute P_<hash>(secret, label + random)[0..dlen]
6729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006731 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6735 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006736 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 }
6738 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6739 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006740 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 }
6742 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6743 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 for (i = 0; i < dlen; i += md_len) {
6748 ret = mbedtls_md_hmac_reset(&md_ctx);
6749 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006750 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 }
6752 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6753 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006754 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 }
6756 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6757 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006758 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006760
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 ret = mbedtls_md_hmac_reset(&md_ctx);
6762 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006763 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 }
6765 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6766 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006767 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 }
6769 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6770 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006771 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006777 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006779 }
6780
6781exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006783
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 if (tmp != NULL) {
6785 mbedtls_platform_zeroize(tmp, tmp_len);
6786 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006787
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006793}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006794#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006795#endif /* MBEDTLS_USE_PSA_CRYPTO */
6796
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006797#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006798MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006799static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6800 const char *label,
6801 const unsigned char *random, size_t rlen,
6802 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006803{
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6805 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006806}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006807#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006808
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006809#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006811static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6812 const char *label,
6813 const unsigned char *random, size_t rlen,
6814 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006815{
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6817 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006818}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006819#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006820
Jerry Yuf009d862022-02-17 14:01:37 +08006821/*
6822 * Set appropriate PRF function and other SSL / TLS1.2 functions
6823 *
6824 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006825 * - hash associated with the ciphersuite (only used by TLS 1.2)
6826 *
6827 * Outputs:
6828 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6829 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006831static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6832 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006833{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006834#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006836 handshake->tls_prf = tls_prf_sha384;
6837 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6838 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006840#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006841#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006842 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006843 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006844 handshake->tls_prf = tls_prf_sha256;
6845 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6846 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6847 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006848#else
Jerry Yuf009d862022-02-17 14:01:37 +08006849 {
Jerry Yuf009d862022-02-17 14:01:37 +08006850 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006851 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006853 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006854#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006857}
Jerry Yud6ab2352022-02-17 14:03:43 +08006858
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006859/*
6860 * Compute master secret if needed
6861 *
6862 * Parameters:
6863 * [in/out] handshake
6864 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6865 * (PSA-PSK) ciphersuite_info, psk_opaque
6866 * [out] premaster (cleared)
6867 * [out] master
6868 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6869 * debug: conf->f_dbg, conf->p_dbg
6870 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006871 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006872 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006874static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6875 unsigned char *master,
6876 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006877{
6878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6879
6880 /* cf. RFC 5246, Section 8.1:
6881 * "The master secret is always exactly 48 bytes in length." */
6882 size_t const master_secret_len = 48;
6883
6884#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6885 unsigned char session_hash[48];
6886#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6887
6888 /* The label for the KDF used for key expansion.
6889 * This is either "master secret" or "extended master secret"
6890 * depending on whether the Extended Master Secret extension
6891 * is used. */
6892 char const *lbl = "master secret";
6893
Przemek Stekielae4ed302022-04-05 17:15:55 +02006894 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006895 * - If the Extended Master Secret extension is not used,
6896 * this is ClientHello.Random + ServerHello.Random
6897 * (see Sect. 8.1 in RFC 5246).
6898 * - If the Extended Master Secret extension is used,
6899 * this is the transcript of the handshake so far.
6900 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006901 unsigned char const *seed = handshake->randbytes;
6902 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006903
6904#if !defined(MBEDTLS_DEBUG_C) && \
6905 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6906 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006908 ssl = NULL; /* make sure we don't use it except for those cases */
6909 (void) ssl;
6910#endif
6911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 if (handshake->resume != 0) {
6913 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6914 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006915 }
6916
6917#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006919 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006920 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006921 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6922 if (ret != 0) {
6923 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6924 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6927 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006928 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006929#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006930
Przemek Stekiel99114f32022-04-22 11:20:09 +02006931#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006932 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006934 /* Perform PSK-to-MS expansion in a single step. */
6935 psa_status_t status;
6936 psa_algorithm_t alg;
6937 mbedtls_svc_key_id_t psk;
6938 psa_key_derivation_operation_t derivation =
6939 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006940 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006947 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006949 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006951
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006952 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006954
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006956 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006957 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006958 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006959 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006960 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006961 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006962 other_secret_len = 48;
6963 other_secret = handshake->premaster + 2;
6964 break;
6965 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006966 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006967 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6968 other_secret = handshake->premaster + 2;
6969 break;
6970 default:
6971 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006972 }
6973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 status = setup_psa_key_derivation(&derivation, psk, alg,
6975 ssl->conf->psk, ssl->conf->psk_len,
6976 seed, seed_len,
6977 (unsigned char const *) lbl,
6978 (size_t) strlen(lbl),
6979 other_secret, other_secret_len,
6980 master_secret_len);
6981 if (status != PSA_SUCCESS) {
6982 psa_key_derivation_abort(&derivation);
6983 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006984 }
6985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 status = psa_key_derivation_output_bytes(&derivation,
6987 master,
6988 master_secret_len);
6989 if (status != PSA_SUCCESS) {
6990 psa_key_derivation_abort(&derivation);
6991 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006992 }
6993
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 status = psa_key_derivation_abort(&derivation);
6995 if (status != PSA_SUCCESS) {
6996 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6997 }
6998 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006999#endif
7000 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007001#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7003 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007004 psa_status_t status;
7005 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7006 psa_key_derivation_operation_t derivation =
7007 PSA_KEY_DERIVATION_OPERATION_INIT;
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007010
7011 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 status = psa_key_derivation_setup(&derivation, alg);
7014 if (status != PSA_SUCCESS) {
7015 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007016 }
7017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 status = psa_key_derivation_set_capacity(&derivation,
7019 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7020 if (status != PSA_SUCCESS) {
7021 psa_key_derivation_abort(&derivation);
7022 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007023 }
7024
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7026 &derivation);
7027 if (status != PSA_SUCCESS) {
7028 psa_key_derivation_abort(&derivation);
7029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007030 }
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 status = psa_key_derivation_output_bytes(&derivation,
7033 handshake->premaster,
7034 handshake->pmslen);
7035 if (status != PSA_SUCCESS) {
7036 psa_key_derivation_abort(&derivation);
7037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7038 }
7039
7040 status = psa_key_derivation_abort(&derivation);
7041 if (status != PSA_SUCCESS) {
7042 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007043 }
7044 }
7045#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7047 lbl, seed, seed_len,
7048 master,
7049 master_secret_len);
7050 if (ret != 0) {
7051 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7052 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053 }
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7056 handshake->premaster,
7057 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 mbedtls_platform_zeroize(handshake->premaster,
7060 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061 }
7062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064}
7065
Gilles Peskine449bd832023-01-11 14:50:10 +01007066int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007067{
7068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7069 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7070 ssl->handshake->ciphersuite_info;
7071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007073
7074 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007076 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (ret != 0) {
7078 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7079 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007080 }
7081
7082 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 ret = ssl_compute_master(ssl->handshake,
7084 ssl->session_negotiate->master,
7085 ssl);
7086 if (ret != 0) {
7087 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7088 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007089 }
7090
7091 /* Swap the client and server random values:
7092 * - MS derivation wanted client+server (RFC 5246 8.1)
7093 * - key derivation wants server+client (RFC 5246 6.3) */
7094 {
7095 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 memcpy(tmp, ssl->handshake->randbytes, 64);
7097 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7098 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7099 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007100 }
7101
7102 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7104 ssl->session_negotiate->ciphersuite,
7105 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007106#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007108#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 ssl->handshake->tls_prf,
7110 ssl->handshake->randbytes,
7111 ssl->tls_version,
7112 ssl->conf->endpoint,
7113 ssl);
7114 if (ret != 0) {
7115 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7116 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007117 }
7118
7119 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7121 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007122
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007126}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007129{
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007131#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007132 case MBEDTLS_SSL_HASH_SHA384:
7133 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7134 break;
7135#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007136#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007137 case MBEDTLS_SSL_HASH_SHA256:
7138 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7139 break;
7140#endif
7141 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007143 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007144#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7145 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007146 (void) ssl;
7147#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007149}
7150
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007151#if defined(MBEDTLS_USE_PSA_CRYPTO)
7152static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7153 const psa_hash_operation_t *hs_op,
7154 size_t buffer_size,
7155 unsigned char *hash,
7156 size_t *hlen)
7157{
7158 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007159 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007160
7161#if !defined(MBEDTLS_DEBUG_C)
7162 (void) ssl;
7163#endif
7164 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007165 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007166 if (status != PSA_SUCCESS) {
7167 goto exit;
7168 }
7169
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007170 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007171 if (status != PSA_SUCCESS) {
7172 goto exit;
7173 }
7174
7175 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7176 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7177
7178exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007179 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007180 return mbedtls_md_error_from_psa(status);
7181}
7182#else
7183static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7184 const mbedtls_md_context_t *hs_ctx,
7185 unsigned char *hash,
7186 size_t *hlen)
7187{
7188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007189 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007190
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007191 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007192
7193#if !defined(MBEDTLS_DEBUG_C)
7194 (void) ssl;
7195#endif
7196 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7197
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007198 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007199 if (ret != 0) {
7200 goto exit;
7201 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007202 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007203 if (ret != 0) {
7204 goto exit;
7205 }
7206
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007207 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007208 if (ret != 0) {
7209 goto exit;
7210 }
7211
7212 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7213
7214 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7215 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7216
7217exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007218 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007219 return ret;
7220}
7221#endif /* MBEDTLS_USE_PSA_CRYPTO */
7222
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007223#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007224int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7225 unsigned char *hash,
7226 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007227{
7228#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007229 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7230 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007231#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007232 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7233 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007234#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007235}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007236#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007237
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007238#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007239int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7240 unsigned char *hash,
7241 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007242{
7243#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007244 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7245 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007246#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007247 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7248 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007249#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007250}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007251#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007252
Neil Armstrong80f6f322022-05-03 17:56:38 +02007253#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7254 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007255int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007256{
7257 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007259 const unsigned char *psk = NULL;
7260 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007262
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007264 /*
7265 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007266 * checked before calling this function.
7267 *
7268 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007269 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7272 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7273 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007274 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007275 }
7276
7277 /*
7278 * PMS = struct {
7279 * opaque other_secret<0..2^16-1>;
7280 * opaque psk<0..2^16-1>;
7281 * };
7282 * with "other_secret" depending on the particular key exchange
7283 */
7284#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7286 if (end - p < 2) {
7287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7288 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007291 p += 2;
7292
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 if (end < p || (size_t) (end - p) < psk_len) {
7294 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7295 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007298 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007300#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7301#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007303 /*
7304 * other_secret already set by the ClientKeyExchange message,
7305 * and is 48 bytes long
7306 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (end - p < 2) {
7308 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7309 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007310
7311 *p++ = 0;
7312 *p++ = 48;
7313 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007315#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7316#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7319 size_t len;
7320
7321 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007323 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7325 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7326 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007327 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007329 p += 2 + len;
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7332 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007333#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007334#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7337 size_t zlen;
7338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007340 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7342 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7343 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007344 }
7345
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007347 p += 2 + zlen;
7348
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7350 MBEDTLS_DEBUG_ECDH_Z);
7351 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007352#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007353 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7355 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007356 }
7357
7358 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (end - p < 2) {
7360 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7361 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007362
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007364 p += 2;
7365
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (end < p || (size_t) (end - p) < psk_len) {
7367 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7368 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007371 p += psk_len;
7372
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007373 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007374
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007376}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007377#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007378
7379#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007381static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007382
7383#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007384int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007385{
7386 /* If renegotiation is not enforced, retransmit until we would reach max
7387 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007389 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7390 unsigned char doublings = 1;
7391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007393 ++doublings;
7394 ratio >>= 1;
7395 }
7396
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (++ssl->renego_records_seen > doublings) {
7398 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7399 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007400 }
7401 }
7402
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007404}
7405#endif
7406#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007407
Jerry Yud9526692022-02-17 14:23:47 +08007408/*
7409 * Handshake functions
7410 */
7411#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7412/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007413int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007414{
7415 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7416 ssl->handshake->ciphersuite_info;
7417
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7421 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007422 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007424 }
7425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7427 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007428}
7429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007431{
7432 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7433 ssl->handshake->ciphersuite_info;
7434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007436
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7438 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007439 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007441 }
7442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7444 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007445}
7446
7447#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7448/* Some certificate support -> implement write and parse */
7449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007451{
7452 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7453 size_t i, n;
7454 const mbedtls_x509_crt *crt;
7455 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7456 ssl->handshake->ciphersuite_info;
7457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7461 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007462 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007464 }
7465
7466#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7468 if (ssl->handshake->client_auth == 0) {
7469 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007470 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007472 }
7473 }
7474#endif /* MBEDTLS_SSL_CLI_C */
7475#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7477 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007478 /* Should never happen because we shouldn't have picked the
7479 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007481 }
7482 }
7483#endif
7484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007486
7487 /*
7488 * 0 . 0 handshake type
7489 * 1 . 3 handshake length
7490 * 4 . 6 length of all certs
7491 * 7 . 9 length of cert. 1
7492 * 10 . n-1 peer certificate
7493 * n . n+2 length of cert. 2
7494 * n+3 . ... upper level cert, etc.
7495 */
7496 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007498
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007500 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7502 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7503 " > %" MBEDTLS_PRINTF_SIZET,
7504 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7505 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007506 }
7507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7509 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7510 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007513 i += n; crt = crt->next;
7514 }
7515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7517 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7518 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007519
7520 ssl->out_msglen = i;
7521 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7522 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7523
7524 ssl->state++;
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7527 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7528 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007529 }
7530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007534}
7535
7536#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7537
7538#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007539MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007540static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7541 unsigned char *crt_buf,
7542 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007543{
7544 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (peer_crt == NULL) {
7547 return -1;
7548 }
Jerry Yud9526692022-02-17 14:23:47 +08007549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 if (peer_crt->raw.len != crt_buf_len) {
7551 return -1;
7552 }
Jerry Yud9526692022-02-17 14:23:47 +08007553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007555}
7556#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007558static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7559 unsigned char *crt_buf,
7560 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007561{
7562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7563 unsigned char const * const peer_cert_digest =
7564 ssl->session->peer_cert_digest;
7565 mbedtls_md_type_t const peer_cert_digest_type =
7566 ssl->session->peer_cert_digest_type;
7567 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007569 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7570 size_t digest_len;
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if (peer_cert_digest == NULL || digest_info == NULL) {
7573 return -1;
7574 }
Jerry Yud9526692022-02-17 14:23:47 +08007575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 digest_len = mbedtls_md_get_size(digest_info);
7577 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7578 return -1;
7579 }
Jerry Yud9526692022-02-17 14:23:47 +08007580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7582 if (ret != 0) {
7583 return -1;
7584 }
Jerry Yud9526692022-02-17 14:23:47 +08007585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007587}
7588#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7589#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7590
7591/*
7592 * Once the certificate message is read, parse it into a cert chain and
7593 * perform basic checks, but leave actual verification to the caller
7594 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007595MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007596static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7597 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007598{
7599 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7600#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007602#endif
7603 size_t i, n;
7604 uint8_t alert;
7605
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7607 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7608 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7609 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7610 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007611 }
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7614 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7615 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7616 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007617 }
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7620 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7621 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7622 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7623 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007624 }
7625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007627
7628 /*
7629 * Same message structure as in mbedtls_ssl_write_certificate()
7630 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007631 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 if (ssl->in_msg[i] != 0 ||
7634 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7635 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7636 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7637 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7638 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007639 }
7640
7641 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7642 i += 3;
7643
7644 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (i + 3 > ssl->in_hslen) {
7648 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7649 mbedtls_ssl_send_alert_message(ssl,
7650 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7651 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7652 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007653 }
7654 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7655 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (ssl->in_msg[i] != 0) {
7657 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7658 mbedtls_ssl_send_alert_message(ssl,
7659 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7660 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7661 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007662 }
7663
7664 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007665 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007666 i += 3;
7667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 if (n < 128 || i + n > ssl->in_hslen) {
7669 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7670 mbedtls_ssl_send_alert_message(ssl,
7671 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7672 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7673 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007674 }
7675
7676 /* Check if we're handling the first CRT in the chain. */
7677#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007679 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007681 /* During client-side renegotiation, check that the server's
7682 * end-CRTs hasn't changed compared to the initial handshake,
7683 * mitigating the triple handshake attack. On success, reuse
7684 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7686 if (ssl_check_peer_crt_unchanged(ssl,
7687 &ssl->in_msg[i],
7688 n) != 0) {
7689 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7690 mbedtls_ssl_send_alert_message(ssl,
7691 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7692 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7693 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007694 }
7695
7696 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007698 }
7699#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7700
7701 /* Parse the next certificate in the chain. */
7702#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007704#else
7705 /* If we don't need to store the CRT chain permanently, parse
7706 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007708#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007710 case 0: /*ok*/
7711 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7712 /* Ignore certificate with an unknown algorithm: maybe a
7713 prior certificate was already trusted. */
7714 break;
7715
7716 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7717 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7718 goto crt_parse_der_failed;
7719
7720 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7721 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7722 goto crt_parse_der_failed;
7723
7724 default:
7725 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007726crt_parse_der_failed:
7727 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7728 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7729 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007730 }
7731
7732 i += n;
7733 }
7734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7736 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007737}
7738
7739#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007740MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007741static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007742{
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7744 return -1;
7745 }
Jerry Yud9526692022-02-17 14:23:47 +08007746
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007748 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7749 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7751 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7752 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007753 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007755}
7756#endif /* MBEDTLS_SSL_SRV_C */
7757
7758/* Check if a certificate message is expected.
7759 * Return either
7760 * - SSL_CERTIFICATE_EXPECTED, or
7761 * - SSL_CERTIFICATE_SKIP
7762 * indicating whether a Certificate message is expected or not.
7763 */
7764#define SSL_CERTIFICATE_EXPECTED 0
7765#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007766MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007767static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7768 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007769{
7770 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7771 ssl->handshake->ciphersuite_info;
7772
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7774 return SSL_CERTIFICATE_SKIP;
7775 }
Jerry Yud9526692022-02-17 14:23:47 +08007776
7777#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7779 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7780 return SSL_CERTIFICATE_SKIP;
7781 }
Jerry Yud9526692022-02-17 14:23:47 +08007782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007784 ssl->session_negotiate->verify_result =
7785 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007787 }
7788 }
7789#else
7790 ((void) authmode);
7791#endif /* MBEDTLS_SSL_SRV_C */
7792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007794}
7795
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007796MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007797static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7798 int authmode,
7799 mbedtls_x509_crt *chain,
7800 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007801{
7802 int ret = 0;
7803 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7804 ssl->handshake->ciphersuite_info;
7805 int have_ca_chain = 0;
7806
7807 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7808 void *p_vrfy;
7809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7811 return 0;
7812 }
Jerry Yud9526692022-02-17 14:23:47 +08007813
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (ssl->f_vrfy != NULL) {
7815 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007816 f_vrfy = ssl->f_vrfy;
7817 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 } else {
7819 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007820 f_vrfy = ssl->conf->f_vrfy;
7821 p_vrfy = ssl->conf->p_vrfy;
7822 }
7823
7824 /*
7825 * Main check: verify certificate
7826 */
7827#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007829 ((void) rs_ctx);
7830 have_ca_chain = 1;
7831
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007833 ret = mbedtls_x509_crt_verify_with_ca_cb(
7834 chain,
7835 ssl->conf->f_ca_cb,
7836 ssl->conf->p_ca_cb,
7837 ssl->conf->cert_profile,
7838 ssl->hostname,
7839 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 f_vrfy, p_vrfy);
7841 } else
Jerry Yud9526692022-02-17 14:23:47 +08007842#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7843 {
7844 mbedtls_x509_crt *ca_chain;
7845 mbedtls_x509_crl *ca_crl;
7846
7847#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007849 ca_chain = ssl->handshake->sni_ca_chain;
7850 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 } else
Jerry Yud9526692022-02-17 14:23:47 +08007852#endif
7853 {
7854 ca_chain = ssl->conf->ca_chain;
7855 ca_crl = ssl->conf->ca_crl;
7856 }
7857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007859 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 }
Jerry Yud9526692022-02-17 14:23:47 +08007861
7862 ret = mbedtls_x509_crt_verify_restartable(
7863 chain,
7864 ca_chain, ca_crl,
7865 ssl->conf->cert_profile,
7866 ssl->hostname,
7867 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007869 }
7870
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 if (ret != 0) {
7872 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007873 }
7874
7875#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7877 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7878 }
Jerry Yud9526692022-02-17 14:23:47 +08007879#endif
7880
7881 /*
7882 * Secondary checks: always done, but change 'ret' only if it was 0
7883 */
7884
Valerio Settiacd32c02023-06-29 18:06:29 +02007885#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007886 {
7887 const mbedtls_pk_context *pk = &chain->pk;
7888
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007889 /* If certificate uses an EC key, make sure the curve is OK.
7890 * This is a public key, so it can't be opaque, so can_do() is a good
7891 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007893 /* and in the unlikely case the above assumption no longer holds
7894 * we are making sure that pk_ec() here does not return a NULL
7895 */
Valerio Settif9362b72023-11-29 08:42:27 +01007896 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007897 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7898 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007900 }
Valerio Setti97207782023-05-18 18:59:06 +02007901 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007902 ssl->session_negotiate->verify_result |=
7903 MBEDTLS_X509_BADCERT_BAD_KEY;
7904
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7906 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007907 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007909 }
Jerry Yud9526692022-02-17 14:23:47 +08007910 }
7911 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007912#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007913
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 if (mbedtls_ssl_check_cert_usage(chain,
7915 ciphersuite_info,
7916 !ssl->conf->endpoint,
7917 &ssl->session_negotiate->verify_result) != 0) {
7918 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7919 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007920 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 }
Jerry Yud9526692022-02-17 14:23:47 +08007922 }
7923
7924 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7925 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7926 * with details encoded in the verification flags. All other kinds
7927 * of error codes, including those from the user provided f_vrfy
7928 * functions, are treated as fatal and lead to a failure of
7929 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7931 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7932 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007933 ret = 0;
7934 }
7935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7937 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007938 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7939 }
7940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007942 uint8_t alert;
7943
7944 /* The certificate may have been rejected for several reasons.
7945 Pick one and send the corresponding alert. Which alert to send
7946 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007948 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007950 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007952 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007954 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007956 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007958 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007960 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007962 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007964 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007966 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007968 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 }
7970 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7971 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007972 }
7973
7974#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (ssl->session_negotiate->verify_result != 0) {
7976 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7977 (unsigned int) ssl->session_negotiate->verify_result));
7978 } else {
7979 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007980 }
7981#endif /* MBEDTLS_DEBUG_C */
7982
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007984}
7985
7986#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007987MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007988static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7989 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007990{
7991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7992 /* Remember digest of the peer's end-CRT. */
7993 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7995 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7996 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7997 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7998 mbedtls_ssl_send_alert_message(ssl,
7999 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8000 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008001
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008003 }
8004
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 ret = mbedtls_md(mbedtls_md_info_from_type(
8006 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8007 start, len,
8008 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008009
8010 ssl->session_negotiate->peer_cert_digest_type =
8011 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8012 ssl->session_negotiate->peer_cert_digest_len =
8013 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8014
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008016}
8017
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008018MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008019static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8020 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008021{
8022 unsigned char *end = start + len;
8023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8024
8025 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8027 ret = mbedtls_pk_parse_subpubkey(&start, end,
8028 &ssl->handshake->peer_pubkey);
8029 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008030 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008032 }
8033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008035}
8036#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008039{
8040 int ret = 0;
8041 int crt_expected;
8042#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8043 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8044 ? ssl->handshake->sni_authmode
8045 : ssl->conf->authmode;
8046#else
8047 const int authmode = ssl->conf->authmode;
8048#endif
8049 void *rs_ctx = NULL;
8050 mbedtls_x509_crt *chain = NULL;
8051
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008053
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8055 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8056 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008057 goto exit;
8058 }
8059
8060#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 if (ssl->handshake->ecrs_enabled &&
8062 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008063 chain = ssl->handshake->ecrs_peer_cert;
8064 ssl->handshake->ecrs_peer_cert = NULL;
8065 goto crt_verify;
8066 }
8067#endif
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008070 /* mbedtls_ssl_read_record may have sent an alert already. We
8071 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008073 goto exit;
8074 }
8075
8076#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8079
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 }
Jerry Yud9526692022-02-17 14:23:47 +08008083
8084 goto exit;
8085 }
8086#endif /* MBEDTLS_SSL_SRV_C */
8087
8088 /* Clear existing peer CRT structure in case we tried to
8089 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8093 if (chain == NULL) {
8094 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8095 sizeof(mbedtls_x509_crt)));
8096 mbedtls_ssl_send_alert_message(ssl,
8097 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8098 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008099
8100 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8101 goto exit;
8102 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008104
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 ret = ssl_parse_certificate_chain(ssl, chain);
8106 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008107 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 }
Jerry Yud9526692022-02-17 14:23:47 +08008109
8110#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008112 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 }
Jerry Yud9526692022-02-17 14:23:47 +08008114
8115crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008117 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 }
Jerry Yud9526692022-02-17 14:23:47 +08008119#endif
8120
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 ret = ssl_parse_certificate_verify(ssl, authmode,
8122 chain, rs_ctx);
8123 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008124 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 }
Jerry Yud9526692022-02-17 14:23:47 +08008126
8127#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8128 {
8129 unsigned char *crt_start, *pk_start;
8130 size_t crt_len, pk_len;
8131
8132 /* We parse the CRT chain without copying, so
8133 * these pointers point into the input buffer,
8134 * and are hence still valid after freeing the
8135 * CRT chain. */
8136
8137 crt_start = chain->raw.p;
8138 crt_len = chain->raw.len;
8139
8140 pk_start = chain->pk_raw.p;
8141 pk_len = chain->pk_raw.len;
8142
8143 /* Free the CRT structures before computing
8144 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 mbedtls_x509_crt_free(chain);
8146 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008147 chain = NULL;
8148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8150 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008151 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 }
Jerry Yud9526692022-02-17 14:23:47 +08008153
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8155 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008156 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 }
Jerry Yud9526692022-02-17 14:23:47 +08008158 }
8159#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8160 /* Pass ownership to session structure. */
8161 ssl->session_negotiate->peer_cert = chain;
8162 chain = NULL;
8163#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8164
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008166
8167exit:
8168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008170 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 }
Jerry Yud9526692022-02-17 14:23:47 +08008172
8173#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008175 ssl->handshake->ecrs_peer_cert = chain;
8176 chain = NULL;
8177 }
8178#endif
8179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 if (chain != NULL) {
8181 mbedtls_x509_crt_free(chain);
8182 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008183 }
8184
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008186}
8187#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8188
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008189static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8190 unsigned char *padbuf, size_t hlen,
8191 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008192{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008193 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008194 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008195#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008196 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008197 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008198 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008199 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008200#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008202 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008203 mbedtls_md_context_t cloned_ctx;
8204 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008205#endif
8206
8207 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008209 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008213 ? "client finished"
8214 : "server finished";
8215
8216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008217 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008218
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008219 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008221 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008222 }
8223
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008224 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008226 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008227 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008228 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008229#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008230 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008231
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008232 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008233 if (ret != 0) {
8234 goto exit;
8235 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008236 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008237 if (ret != 0) {
8238 goto exit;
8239 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008240
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008241 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008242 if (ret != 0) {
8243 goto exit;
8244 }
8245#endif /* MBEDTLS_USE_PSA_CRYPTO */
8246
8247 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8248
Jerry Yu615bd6f2022-02-17 14:25:15 +08008249 /*
8250 * TLSv1.2:
8251 * hash = PRF( master, finished_label,
8252 * Hash( handshake ) )[0.11]
8253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008255 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008256
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008258
Paul Elliottecb95be2023-08-11 16:41:04 +01008259 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008260
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008262
8263exit:
8264#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008265 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008266 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008267#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008268 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008269 return ret;
8270#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008271}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008272
8273#if defined(MBEDTLS_MD_CAN_SHA256)
8274static int ssl_calc_finished_tls_sha256(
8275 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8276{
8277 unsigned char padbuf[32];
8278 return ssl_calc_finished_tls_generic(ssl,
8279#if defined(MBEDTLS_USE_PSA_CRYPTO)
8280 &ssl->handshake->fin_sha256_psa,
8281#else
8282 &ssl->handshake->fin_sha256,
8283#endif
8284 padbuf, sizeof(padbuf),
8285 buf, from);
8286}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008287#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008288
Jerry Yub7ba49e2022-02-17 14:25:53 +08008289
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008290#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008291static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008293{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008294 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008295 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008297 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008298#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008299 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008300#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008301 padbuf, sizeof(padbuf),
8302 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008303}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008304#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008305
Gilles Peskine449bd832023-01-11 14:50:10 +01008306void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008307{
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008309
8310 /*
8311 * Free our handshake params
8312 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 mbedtls_ssl_handshake_free(ssl);
8314 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008315 ssl->handshake = NULL;
8316
8317 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008318 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 if (ssl->transform) {
8321 mbedtls_ssl_transform_free(ssl->transform);
8322 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008323 }
8324 ssl->transform = ssl->transform_negotiate;
8325 ssl->transform_negotiate = NULL;
8326
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008328}
8329
Gilles Peskine449bd832023-01-11 14:50:10 +01008330void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008331{
8332 int resume = ssl->handshake->resume;
8333
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008335
8336#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008338 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8339 ssl->renego_records_seen = 0;
8340 }
8341#endif
8342
8343 /*
8344 * Free the previous session and switch in the current one
8345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008347#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8348 /* RFC 7366 3.1: keep the EtM state */
8349 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008351#endif
8352
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 mbedtls_ssl_session_free(ssl->session);
8354 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008355 }
8356 ssl->session = ssl->session_negotiate;
8357 ssl->session_negotiate = NULL;
8358
8359 /*
8360 * Add cache entry
8361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008363 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 resume == 0) {
8365 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8366 ssl->session->id,
8367 ssl->session->id_len,
8368 ssl->session) != 0) {
8369 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8370 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008371 }
8372
8373#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8375 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008376 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008378
8379 /* Keep last flight around in case we need to resend it:
8380 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8382 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008385
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008386 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008387
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008389}
8390
Gilles Peskine449bd832023-01-11 14:50:10 +01008391int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008392{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008393 int ret;
8394 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008395
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008397
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008399
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008400 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8401 if (ret != 0) {
8402 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8403 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008404
8405 /*
8406 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8407 * may define some other value. Currently (early 2016), no defined
8408 * ciphersuite does this (and this is unlikely to change as activity has
8409 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8410 */
8411 hash_len = 12;
8412
8413#if defined(MBEDTLS_SSL_RENEGOTIATION)
8414 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008416#endif
8417
8418 ssl->out_msglen = 4 + hash_len;
8419 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8420 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8421
8422 /*
8423 * In case of session resuming, invert the client and server
8424 * ChangeCipherSpec messages order.
8425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008427#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008429 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008431#endif
8432#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008434 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008436#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008438 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008439 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008440
8441 /*
8442 * Switch to our negotiated transform and session parameters for outbound
8443 * data.
8444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008446
8447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008449 unsigned char i;
8450
8451 /* Remember current epoch settings for resending */
8452 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8454 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008455
8456 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008458
8459
8460 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 for (i = 2; i > 0; i--) {
8462 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008463 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 }
8465 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008466
8467 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if (i == 0) {
8469 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8470 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008471 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008473#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008475
8476 ssl->transform_out = ssl->transform_negotiate;
8477 ssl->session_out = ssl->session_negotiate;
8478
8479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8481 mbedtls_ssl_send_flight_completed(ssl);
8482 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008483#endif
8484
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8486 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8487 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008488 }
8489
8490#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8492 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8493 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8494 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008495 }
8496#endif
8497
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008501}
8502
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008503#define SSL_MAX_HASH_LEN 12
8504
Gilles Peskine449bd832023-01-11 14:50:10 +01008505int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008506{
8507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8508 unsigned int hash_len = 12;
8509 unsigned char buf[SSL_MAX_HASH_LEN];
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008512
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008513 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8514 if (ret != 0) {
8515 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8516 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8519 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008520 goto exit;
8521 }
8522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8524 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8525 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8526 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008527 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8528 goto exit;
8529 }
8530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8532 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8533 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008534 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8535 goto exit;
8536 }
8537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8539 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8540 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8541 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008542 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8543 goto exit;
8544 }
8545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8547 buf, hash_len) != 0) {
8548 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8549 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8550 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008551 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8552 goto exit;
8553 }
8554
8555#if defined(MBEDTLS_SSL_RENEGOTIATION)
8556 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008558#endif
8559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008561#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008563 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008565#endif
8566#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008568 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008570#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008572 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008574
8575#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8577 mbedtls_ssl_recv_flight_completed(ssl);
8578 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008579#endif
8580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008582
8583exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 mbedtls_platform_zeroize(buf, hash_len);
8585 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008586}
8587
Jerry Yu392112c2022-02-17 14:34:10 +08008588#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8589/*
8590 * Helper to get TLS 1.2 PRF from ciphersuite
8591 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008593static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008594{
Jerry Yu392112c2022-02-17 14:34:10 +08008595 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008597#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8599 return tls_prf_sha384;
8600 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008601#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008602#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008603 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8605 return tls_prf_sha256;
8606 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008607 }
8608#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008609#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8610 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008611 (void) ciphersuite_info;
8612#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008615}
8616#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008619{
8620 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008621#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 if (tls_prf == tls_prf_sha384) {
8623 return MBEDTLS_SSL_TLS_PRF_SHA384;
8624 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008625#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008626#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 if (tls_prf == tls_prf_sha256) {
8628 return MBEDTLS_SSL_TLS_PRF_SHA256;
8629 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008630#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008632}
8633
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008634/*
8635 * Populate a transform structure with session keys and all the other
8636 * necessary information.
8637 *
8638 * Parameters:
8639 * - [in/out]: transform: structure to populate
8640 * [in] must be just initialised with mbedtls_ssl_transform_init()
8641 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8642 * - [in] ciphersuite
8643 * - [in] master
8644 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008645 * - [in] tls_prf: pointer to PRF to use for key derivation
8646 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008647 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008648 * - [in] endpoint: client or server
8649 * - [in] ssl: used for:
8650 * - ssl->conf->{f,p}_export_keys
8651 * [in] optionally used for:
8652 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8653 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008654MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008655static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8656 int ciphersuite,
8657 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008658#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008660#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 ssl_tls_prf_t tls_prf,
8662 const unsigned char randbytes[64],
8663 mbedtls_ssl_protocol_version tls_version,
8664 unsigned endpoint,
8665 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008666{
8667 int ret = 0;
8668 unsigned char keyblk[256];
8669 unsigned char *key1;
8670 unsigned char *key2;
8671 unsigned char *mac_enc;
8672 unsigned char *mac_dec;
8673 size_t mac_key_len = 0;
8674 size_t iv_copy_len;
8675 size_t keylen;
8676 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008677 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008678#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008679 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008680 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008681#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008682
8683#if defined(MBEDTLS_USE_PSA_CRYPTO)
8684 psa_key_type_t key_type;
8685 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8686 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008687 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008688 size_t key_bits;
8689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8690#endif
8691
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008692 /*
8693 * Some data just needs copying into the structure
8694 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008695#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008696 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008697#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008698 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008699
8700#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008702#endif
8703
8704#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008706 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8707 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008709 }
8710#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8711
8712 /*
8713 * Get various info structures
8714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8716 if (ciphersuite_info == NULL) {
8717 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8718 ciphersuite));
8719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008720 }
8721
Neil Armstrongab555e02022-04-04 11:07:59 +02008722 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008723#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008725#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008727
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008729 transform->taglen =
8730 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008732
8733#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008734 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008735 transform->taglen,
8736 &alg,
8737 &key_type,
8738 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008739 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008741 goto end;
8742 }
8743#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008744 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 if (cipher_info == NULL) {
8746 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8747 ciphersuite_info->cipher));
8748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008749 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008750#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008751
Neil Armstronge4512952022-03-08 09:08:22 +01008752#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008753 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008755 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 (unsigned) ciphersuite_info->mac));
8757 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008758 }
8759#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008760 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 if (md_info == NULL) {
8762 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8763 (unsigned) ciphersuite_info->mac));
8764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008765 }
Neil Armstronge4512952022-03-08 09:08:22 +01008766#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008767
8768#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8769 /* Copy own and peer's CID if the use of the CID
8770 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008771 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8772 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008773
8774 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8776 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8777 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008778
8779 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8781 ssl->handshake->peer_cid_len);
8782 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8783 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008784 }
8785#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8786
8787 /*
8788 * Compute key block using the PRF
8789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8791 if (ret != 0) {
8792 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8793 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008794 }
8795
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8797 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8798 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8799 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8800 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008801
8802 /*
8803 * Determine the appropriate key, IV and MAC length.
8804 */
8805
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008806#if defined(MBEDTLS_USE_PSA_CRYPTO)
8807 keylen = PSA_BITS_TO_BYTES(key_bits);
8808#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008810#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811
Valerio Settie5707042023-10-11 11:54:42 +02008812#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008814 size_t explicit_ivlen;
8815
8816 transform->maclen = 0;
8817 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008818
8819 /* All modes haves 96-bit IVs, but the length of the static parts vary
8820 * with mode and version:
8821 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8822 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8823 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8824 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8825 * sequence number).
8826 */
8827 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008828
8829 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008830#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008832#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8834 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008835#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008836
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008838 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842
8843 /* Minimum length of encrypted record */
8844 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8845 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 } else
Valerio Settie5707042023-10-11 11:54:42 +02008847#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008848#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008850 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008852#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008854#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008855 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008856#endif /* MBEDTLS_USE_PSA_CRYPTO */
8857
8858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008859 /* Get MAC length */
8860 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8861#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008862 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8864 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008866 goto end;
8867 }
8868
8869 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008871#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008872 transform->maclen = mac_key_len;
8873
8874 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008875#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008877#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008878 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008879#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008880
8881 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008883 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008885 /*
8886 * GenericBlockCipher:
8887 * 1. if EtM is in use: one block plus MAC
8888 * otherwise: * first multiple of blocklen greater than maclen
8889 * 2. IV
8890 */
8891#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008893 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 + block_size;
8895 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008896#endif
8897 {
8898 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 + block_size
8900 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008901 }
8902
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008904 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 } else {
8906 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008907 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8908 goto end;
8909 }
8910 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008912#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8913 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8915 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008916 }
8917
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8919 (unsigned) keylen,
8920 (unsigned) transform->minlen,
8921 (unsigned) transform->ivlen,
8922 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008923
8924 /*
8925 * Finally setup the cipher contexts, IVs and MAC secrets.
8926 */
8927#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008929 key1 = keyblk + mac_key_len * 2;
8930 key2 = keyblk + mac_key_len * 2 + keylen;
8931
8932 mac_enc = keyblk;
8933 mac_dec = keyblk + mac_key_len;
8934
Gilles Peskine449bd832023-01-11 14:50:10 +01008935 iv_copy_len = (transform->fixed_ivlen) ?
8936 transform->fixed_ivlen : transform->ivlen;
8937 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8938 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8939 iv_copy_len);
8940 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008941#endif /* MBEDTLS_SSL_CLI_C */
8942#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944 key1 = keyblk + mac_key_len * 2 + keylen;
8945 key2 = keyblk + mac_key_len * 2;
8946
8947 mac_enc = keyblk + mac_key_len;
8948 mac_dec = keyblk;
8949
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 iv_copy_len = (transform->fixed_ivlen) ?
8951 transform->fixed_ivlen : transform->ivlen;
8952 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8953 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8954 iv_copy_len);
8955 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008956#endif /* MBEDTLS_SSL_SRV_C */
8957 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008959 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8960 goto end;
8961 }
8962
Paul Elliott4fb19552023-10-18 12:15:30 +01008963 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 ssl->f_export_keys(ssl->p_export_keys,
8965 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8966 master, 48,
8967 randbytes + 32,
8968 randbytes,
8969 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008970 }
8971
8972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008973 transform->psa_alg = alg;
8974
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8976 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8977 psa_set_key_algorithm(&attributes, alg);
8978 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008979
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 if ((status = psa_import_key(&attributes,
8981 key1,
8982 PSA_BITS_TO_BYTES(key_bits),
8983 &transform->psa_key_enc)) != PSA_SUCCESS) {
8984 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008985 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008987 goto end;
8988 }
8989
Gilles Peskine449bd832023-01-11 14:50:10 +01008990 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008991
Gilles Peskine449bd832023-01-11 14:50:10 +01008992 if ((status = psa_import_key(&attributes,
8993 key2,
8994 PSA_BITS_TO_BYTES(key_bits),
8995 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008996 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008998 goto end;
8999 }
9000 }
9001#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9003 cipher_info)) != 0) {
9004 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005 goto end;
9006 }
9007
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9009 cipher_info)) != 0) {
9010 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009011 goto end;
9012 }
9013
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9015 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9016 MBEDTLS_ENCRYPT)) != 0) {
9017 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009018 goto end;
9019 }
9020
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9022 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9023 MBEDTLS_DECRYPT)) != 0) {
9024 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025 goto end;
9026 }
9027
9028#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9030 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9031 MBEDTLS_PADDING_NONE)) != 0) {
9032 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009033 goto end;
9034 }
9035
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9037 MBEDTLS_PADDING_NONE)) != 0) {
9038 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009039 goto end;
9040 }
9041 }
9042#endif /* MBEDTLS_CIPHER_MODE_CBC */
9043#endif /* MBEDTLS_USE_PSA_CRYPTO */
9044
Neil Armstrong29c0c042022-03-17 17:47:28 +01009045#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9046 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9047 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009049#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9053 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9054 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009055
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 if ((status = psa_import_key(&attributes,
9057 mac_enc, mac_key_len,
9058 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009059 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009061 goto end;
9062 }
9063
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9065 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009066#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009068#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009070 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9072 PSA_KEY_USAGE_VERIFY_HASH);
9073 } else {
9074 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9075 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 if ((status = psa_import_key(&attributes,
9078 mac_dec, mac_key_len,
9079 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009080 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009082 goto end;
9083 }
9084#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9086 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009087 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 }
9089 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9090 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009091 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009093#endif /* MBEDTLS_USE_PSA_CRYPTO */
9094 }
9095#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9096
9097 ((void) mac_dec);
9098 ((void) mac_enc);
9099
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009100end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9102 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009103}
9104
Valerio Settia08b1a42022-11-17 15:10:02 +01009105#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9106 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009107int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 psa_pake_operation_t *pake_ctx,
9109 const unsigned char *buf,
9110 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009111{
9112 psa_status_t status;
9113 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009114 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009115 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9116 * At round two perform a single cycle
9117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009118 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009119
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 for (; remaining_steps > 0; remaining_steps--) {
9121 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009122 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009124 /* Length is stored at the first byte */
9125 size_t length = buf[input_offset];
9126 input_offset += 1;
9127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009129 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9130 }
9131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 status = psa_pake_input(pake_ctx, step,
9133 buf + input_offset, length);
9134 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009135 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009136 }
9137
9138 input_offset += length;
9139 }
9140 }
9141
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009143 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009145
Gilles Peskine449bd832023-01-11 14:50:10 +01009146 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009147}
9148
Valerio Setti6b3dab02022-11-17 17:14:54 +01009149int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 psa_pake_operation_t *pake_ctx,
9151 unsigned char *buf,
9152 size_t len, size_t *olen,
9153 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009154{
9155 psa_status_t status;
9156 size_t output_offset = 0;
9157 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009158 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009159 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9160 * At round two perform a single cycle
9161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009163
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 for (; remaining_steps > 0; remaining_steps--) {
9165 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9166 step <= PSA_PAKE_STEP_ZK_PROOF;
9167 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009168 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009169 * For each step, prepend 1 byte with the length of the data as
9170 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 status = psa_pake_output(pake_ctx, step,
9173 buf + output_offset + 1,
9174 len - output_offset - 1,
9175 &output_len);
9176 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009177 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009178 }
9179
Valerio Setti99d88c12022-11-22 16:03:43 +01009180 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009181
9182 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009183 }
9184 }
9185
9186 *olen = output_offset;
9187
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009189}
Valerio Settia08b1a42022-11-17 15:10:02 +01009190#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9191
Jerry Yuee40f9d2022-02-17 14:55:16 +08009192#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009193int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9194 unsigned char *hash, size_t *hashlen,
9195 unsigned char *data, size_t data_len,
9196 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009197{
9198 psa_status_t status;
9199 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009200 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009201
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009203
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if ((status = psa_hash_setup(&hash_operation,
9205 hash_alg)) != PSA_SUCCESS) {
9206 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009207 goto exit;
9208 }
9209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9211 64)) != PSA_SUCCESS) {
9212 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009213 goto exit;
9214 }
9215
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 if ((status = psa_hash_update(&hash_operation,
9217 data, data_len)) != PSA_SUCCESS) {
9218 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009219 goto exit;
9220 }
9221
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9223 hashlen)) != PSA_SUCCESS) {
9224 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9225 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009226 }
9227
9228exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 if (status != PSA_SUCCESS) {
9230 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9231 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9232 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009233 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009235 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9236 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009238 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009240 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009242 }
9243 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009244 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009245}
9246
9247#else
9248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9250 unsigned char *hash, size_t *hashlen,
9251 unsigned char *data, size_t data_len,
9252 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009253{
9254 int ret = 0;
9255 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9257 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009260
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009262
9263 /*
9264 * digitally-signed struct {
9265 * opaque client_random[32];
9266 * opaque server_random[32];
9267 * ServerDHParams params;
9268 * };
9269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009270 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9271 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009272 goto exit;
9273 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9275 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009276 goto exit;
9277 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9279 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009280 goto exit;
9281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9283 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009284 goto exit;
9285 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9287 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009288 goto exit;
9289 }
9290
9291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 if (ret != 0) {
9295 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9296 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9297 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009298
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009300}
9301#endif /* MBEDTLS_USE_PSA_CRYPTO */
9302
Jerry Yud9d91da2022-02-17 14:57:06 +08009303#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9304
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009305/* Find the preferred hash for a given signature algorithm. */
9306unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 mbedtls_ssl_context *ssl,
9308 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009309{
Gabor Mezei078e8032022-04-27 21:17:56 +02009310 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009311 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009312
Gilles Peskine449bd832023-01-11 14:50:10 +01009313 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9314 return MBEDTLS_SSL_HASH_NONE;
9315 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009316
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009318 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9320 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009321 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9323 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009324
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009325 mbedtls_md_type_t md_alg =
9326 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9327 if (md_alg == MBEDTLS_MD_NONE) {
9328 continue;
9329 }
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009334 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009335 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9338 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9339 PSA_ALG_ECDSA(psa_hash_alg),
9340 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009341 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009342 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009343
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9345 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9346 PSA_ALG_RSA_PKCS1V15_SIGN(
9347 psa_hash_alg),
9348 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009349 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009351 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009352#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009353
Gilles Peskine449bd832023-01-11 14:50:10 +01009354 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009355 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009356 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009357
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009359}
9360
9361#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9362
Jerry Yudc7bd172022-02-17 13:44:15 +08009363#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9364
XiaokangQian75d40ef2022-04-20 11:05:24 +00009365int mbedtls_ssl_validate_ciphersuite(
9366 const mbedtls_ssl_context *ssl,
9367 const mbedtls_ssl_ciphersuite_t *suite_info,
9368 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009370{
9371 (void) ssl;
9372
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 if (suite_info == NULL) {
9374 return -1;
9375 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009376
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 if ((suite_info->min_tls_version > max_tls_version) ||
9378 (suite_info->max_tls_version < min_tls_version)) {
9379 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009380 }
9381
XiaokangQian060d8672022-04-21 09:24:56 +00009382#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009383#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009384#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9386 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009387#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9389 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009390#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009391 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009393 }
9394#endif
9395
9396 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9397#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009398 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9399 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9400 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009401 }
9402#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9403#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9404
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009406}
9407
Ronald Crone68ab4f2022-10-05 12:46:29 +02009408#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009409/*
9410 * Function for writing a signature algorithm extension.
9411 *
9412 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9413 * value (TLS 1.3 RFC8446):
9414 * enum {
9415 * ....
9416 * ecdsa_secp256r1_sha256( 0x0403 ),
9417 * ecdsa_secp384r1_sha384( 0x0503 ),
9418 * ecdsa_secp521r1_sha512( 0x0603 ),
9419 * ....
9420 * } SignatureScheme;
9421 *
9422 * struct {
9423 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9424 * } SignatureSchemeList;
9425 *
9426 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9427 * value (TLS 1.2 RFC5246):
9428 * enum {
9429 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9430 * sha512(6), (255)
9431 * } HashAlgorithm;
9432 *
9433 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9434 * SignatureAlgorithm;
9435 *
9436 * struct {
9437 * HashAlgorithm hash;
9438 * SignatureAlgorithm signature;
9439 * } SignatureAndHashAlgorithm;
9440 *
9441 * SignatureAndHashAlgorithm
9442 * supported_signature_algorithms<2..2^16-2>;
9443 *
9444 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9445 * generalization of the TLS 1.2 signature algorithm extension.
9446 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9447 * `SignatureScheme` field of TLS 1.3
9448 *
9449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009450int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9451 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009452{
9453 unsigned char *p = buf;
9454 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9455 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9456
9457 *out_len = 0;
9458
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009460
9461 /* Check if we have space for header and length field:
9462 * - extension_type (2 bytes)
9463 * - extension_data_length (2 bytes)
9464 * - supported_signature_algorithms_length (2 bytes)
9465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009466 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009467 p += 6;
9468
9469 /*
9470 * Write supported_signature_algorithms
9471 */
9472 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9474 if (sig_alg == NULL) {
9475 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9476 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009477
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9479 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9480 *sig_alg,
9481 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9482 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009483 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 }
9485 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9486 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009487 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9489 *sig_alg,
9490 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009491 }
9492
9493 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009494 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009495 if (supported_sig_alg_len == 0) {
9496 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9497 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009498 }
9499
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9501 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9502 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009503
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009504 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009505
9506#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009508#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009511}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009512#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009513
XiaokangQian40a35232022-05-07 09:02:40 +00009514#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009515/*
9516 * mbedtls_ssl_parse_server_name_ext
9517 *
9518 * Structure of server_name extension:
9519 *
9520 * enum {
9521 * host_name(0), (255)
9522 * } NameType;
9523 * opaque HostName<1..2^16-1>;
9524 *
9525 * struct {
9526 * NameType name_type;
9527 * select (name_type) {
9528 * case host_name: HostName;
9529 * } name;
9530 * } ServerName;
9531 * struct {
9532 * ServerName server_name_list<1..2^16-1>
9533 * } ServerNameList;
9534 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009535MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009536int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9537 const unsigned char *buf,
9538 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009539{
9540 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9541 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009542 size_t server_name_list_len, hostname_len;
9543 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009546
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9548 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009549 p += 2;
9550
Gilles Peskine449bd832023-01-11 14:50:10 +01009551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009552 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 while (p < server_name_list_end) {
9554 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9555 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9557 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009558
Gilles Peskine449bd832023-01-11 14:50:10 +01009559 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009560 /* sni_name is intended to be used only during the parsing of the
9561 * ClientHello message (it is reset to NULL before the end of
9562 * the message parsing). Thus it is ok to just point to the
9563 * reception buffer and not make a copy of it.
9564 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009565 ssl->handshake->sni_name = p + 3;
9566 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 if (ssl->conf->f_sni == NULL) {
9568 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009570 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9571 ssl, p + 3, hostname_len);
9572 if (ret != 0) {
9573 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9574 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9575 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9576 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9577 }
9578 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009579 }
9580
9581 p += hostname_len + 3;
9582 }
9583
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009585}
9586#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9587
XiaokangQianacb39922022-06-17 10:18:48 +00009588#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009589MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009590int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9591 const unsigned char *buf,
9592 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009593{
9594 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009595 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009596 const unsigned char *protocol_name_list;
9597 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009598 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009599
9600 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 if (ssl->conf->alpn_list == NULL) {
9602 return 0;
9603 }
XiaokangQianacb39922022-06-17 10:18:48 +00009604
9605 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009606 * RFC7301, section 3.1
9607 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009608 *
XiaokangQianc7403452022-06-23 03:24:12 +00009609 * struct {
9610 * ProtocolName protocol_name_list<2..2^16-1>
9611 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009612 */
9613
XiaokangQianc7403452022-06-23 03:24:12 +00009614 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009615 * protocol_name_list_len 2 bytes
9616 * protocol_name_len 1 bytes
9617 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009619 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009620
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009622 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009624 protocol_name_list = p;
9625 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009626
9627 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009628 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009629 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9631 protocol_name_len);
9632 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009633 MBEDTLS_SSL_PEND_FATAL_ALERT(
9634 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9636 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009637 }
9638
9639 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009640 }
9641
9642 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9644 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009645 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009647 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009648 if (protocol_name_len == alpn_len &&
9649 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009650 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009651 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009652 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009653
9654 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009655 }
9656 }
9657
XiaokangQian95d5f542022-06-24 02:29:26 +00009658 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009659 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009660 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9661 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9662 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009663}
9664
Gilles Peskine449bd832023-01-11 14:50:10 +01009665int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9666 unsigned char *buf,
9667 unsigned char *end,
9668 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009669{
9670 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009671 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009672 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009673
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 if (ssl->alpn_chosen == NULL) {
9675 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009676 }
9677
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 protocol_name_len = strlen(ssl->alpn_chosen);
9679 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009680
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009682 /*
9683 * 0 . 1 ext identifier
9684 * 2 . 3 ext length
9685 * 4 . 5 protocol list length
9686 * 6 . 6 protocol name length
9687 * 7 . 7+n protocol name
9688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009690
XiaokangQian95d5f542022-06-24 02:29:26 +00009691 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009692
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9694 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009695 /* Note: the length of the chosen protocol has been checked to be less
9696 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009698 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009699
Gilles Peskine449bd832023-01-11 14:50:10 +01009700 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009701
9702#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009703 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009704#endif
9705
Gilles Peskine449bd832023-01-11 14:50:10 +01009706 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009707}
9708#endif /* MBEDTLS_SSL_ALPN */
9709
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009710#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009711 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009712 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009713 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009714int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9715 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009716{
9717 /* Initialize to suppress unnecessary compiler warning */
9718 size_t hostname_len = 0;
9719
9720 /* Check if new hostname is valid before
9721 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009722 if (hostname != NULL) {
9723 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009724
Gilles Peskine449bd832023-01-11 14:50:10 +01009725 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9727 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009728 }
9729
9730 /* Now it's clear that we will overwrite the old hostname,
9731 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009732 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009733 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009734 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009735 }
9736
9737 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009738 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009739 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009740 } else {
9741 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9742 if (session->hostname == NULL) {
9743 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9744 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009745
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009747 }
9748
Gilles Peskine449bd832023-01-11 14:50:10 +01009749 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009750}
Xiaokang Qian03409292022-10-12 02:49:52 +00009751#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9752 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009753 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009754 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009755
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009756#endif /* MBEDTLS_SSL_TLS_C */