Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1 | /** |
Chris Jones | 84a773f | 2021-03-05 18:38:47 +0000 | [diff] [blame] | 2 | * \file ssl_misc.h |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 3 | * |
| 4 | * \brief Internal functions shared by the SSL modules |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 5 | */ |
| 6 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 7 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 8 | * SPDX-License-Identifier: Apache-2.0 |
| 9 | * |
| 10 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 11 | * not use this file except in compliance with the License. |
| 12 | * You may obtain a copy of the License at |
| 13 | * |
| 14 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 15 | * |
| 16 | * Unless required by applicable law or agreed to in writing, software |
| 17 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 18 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 19 | * See the License for the specific language governing permissions and |
| 20 | * limitations under the License. |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 21 | */ |
Chris Jones | 84a773f | 2021-03-05 18:38:47 +0000 | [diff] [blame] | 22 | #ifndef MBEDTLS_SSL_MISC_H |
| 23 | #define MBEDTLS_SSL_MISC_H |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 24 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 25 | #include "mbedtls/build_info.h" |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 26 | |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 27 | #include "mbedtls/ssl.h" |
| 28 | #include "mbedtls/cipher.h" |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 29 | |
Przemyslaw Stekiel | b15f33d | 2022-02-10 10:12:12 +0100 | [diff] [blame] | 30 | #if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 31 | #include "psa/crypto.h" |
Przemyslaw Stekiel | b15f33d | 2022-02-10 10:12:12 +0100 | [diff] [blame] | 32 | #include "mbedtls/psa_util.h" |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 33 | #include "hash_info.h" |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 34 | #endif |
Manuel Pégourié-Gonnard | 07018f9 | 2022-09-15 11:29:35 +0200 | [diff] [blame] | 35 | #include "mbedtls/legacy_or_psa.h" |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 36 | |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 37 | #if defined(MBEDTLS_MD5_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 38 | #include "mbedtls/md5.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 39 | #endif |
| 40 | |
| 41 | #if defined(MBEDTLS_SHA1_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 42 | #include "mbedtls/sha1.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 43 | #endif |
| 44 | |
| 45 | #if defined(MBEDTLS_SHA256_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 46 | #include "mbedtls/sha256.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 47 | #endif |
| 48 | |
| 49 | #if defined(MBEDTLS_SHA512_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 50 | #include "mbedtls/sha512.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 51 | #endif |
| 52 | |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 53 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 54 | #include "mbedtls/ecjpake.h" |
Manuel Pégourié-Gonnard | 76cfd3f | 2015-09-15 12:10:54 +0200 | [diff] [blame] | 55 | #endif |
| 56 | |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 57 | #include "common.h" |
| 58 | |
Manuel Pégourié-Gonnard | 0223ab9 | 2015-10-05 11:40:01 +0100 | [diff] [blame] | 59 | #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \ |
| 60 | !defined(inline) && !defined(__cplusplus) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 61 | #define inline __inline |
Manuel Pégourié-Gonnard | 20af64d | 2015-07-07 18:33:39 +0200 | [diff] [blame] | 62 | #endif |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 63 | |
Manuel Pégourié-Gonnard | 862cde5 | 2017-05-17 11:56:15 +0200 | [diff] [blame] | 64 | /* Shorthand for restartable ECC */ |
Manuel Pégourié-Gonnard | 2350b4e | 2017-05-16 09:26:48 +0200 | [diff] [blame] | 65 | #if defined(MBEDTLS_ECP_RESTARTABLE) && \ |
| 66 | defined(MBEDTLS_SSL_CLI_C) && \ |
| 67 | defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
| 68 | defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 69 | #define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED |
Manuel Pégourié-Gonnard | 2350b4e | 2017-05-16 09:26:48 +0200 | [diff] [blame] | 70 | #endif |
| 71 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 72 | #define MBEDTLS_SSL_INITIAL_HANDSHAKE 0 |
| 73 | #define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */ |
| 74 | #define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */ |
| 75 | #define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */ |
| 76 | |
Jerry Yu | d25cab0 | 2022-10-31 12:48:30 +0800 | [diff] [blame] | 77 | /* Faked handshake message identity for HelloRetryRequest. */ |
| 78 | #define MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST ( -MBEDTLS_SSL_HS_SERVER_HELLO ) |
| 79 | |
Xiaokang Qian | 338f727 | 2022-11-02 07:18:30 +0000 | [diff] [blame] | 80 | /* Early data indication sent or not */ |
| 81 | #define MBEDTLS_SSL_EARLY_DATA_OFF 0 |
| 82 | #define MBEDTLS_SSL_EARLY_DATA_ON 1 |
| 83 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 84 | /* |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 85 | * Internal identity of handshake extensions |
Jerry Yu | 8e7ca04 | 2021-08-26 15:31:37 +0800 | [diff] [blame] | 86 | */ |
Jerry Yu | 7a485c1 | 2022-10-31 13:08:18 +0800 | [diff] [blame] | 87 | #define MBEDTLS_SSL_EXT_ID_UNRECOGNIZED 0 |
| 88 | #define MBEDTLS_SSL_EXT_ID_SERVERNAME 1 |
| 89 | #define MBEDTLS_SSL_EXT_ID_SERVERNAME_HOSTNAME 1 |
| 90 | #define MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH 2 |
| 91 | #define MBEDTLS_SSL_EXT_ID_STATUS_REQUEST 3 |
| 92 | #define MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS 4 |
| 93 | #define MBEDTLS_SSL_EXT_ID_SUPPORTED_ELLIPTIC_CURVES 4 |
| 94 | #define MBEDTLS_SSL_EXT_ID_SIG_ALG 5 |
| 95 | #define MBEDTLS_SSL_EXT_ID_USE_SRTP 6 |
| 96 | #define MBEDTLS_SSL_EXT_ID_HEARTBEAT 7 |
| 97 | #define MBEDTLS_SSL_EXT_ID_ALPN 8 |
| 98 | #define MBEDTLS_SSL_EXT_ID_SCT 9 |
| 99 | #define MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE 10 |
| 100 | #define MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE 11 |
| 101 | #define MBEDTLS_SSL_EXT_ID_PADDING 12 |
| 102 | #define MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY 13 |
| 103 | #define MBEDTLS_SSL_EXT_ID_EARLY_DATA 14 |
| 104 | #define MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS 15 |
| 105 | #define MBEDTLS_SSL_EXT_ID_COOKIE 16 |
| 106 | #define MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES 17 |
| 107 | #define MBEDTLS_SSL_EXT_ID_CERT_AUTH 18 |
| 108 | #define MBEDTLS_SSL_EXT_ID_OID_FILTERS 19 |
| 109 | #define MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH 20 |
| 110 | #define MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT 21 |
| 111 | #define MBEDTLS_SSL_EXT_ID_KEY_SHARE 22 |
| 112 | #define MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC 23 |
| 113 | #define MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS 24 |
| 114 | #define MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC 25 |
| 115 | #define MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET 26 |
| 116 | #define MBEDTLS_SSL_EXT_ID_SESSION_TICKET 27 |
Jerry Yu | 8e7ca04 | 2021-08-26 15:31:37 +0800 | [diff] [blame] | 117 | |
Jerry Yu | 7a485c1 | 2022-10-31 13:08:18 +0800 | [diff] [blame] | 118 | /* Utility for translating IANA extension type. */ |
| 119 | uint32_t mbedtls_ssl_get_extension_id( unsigned int extension_type ); |
| 120 | uint32_t mbedtls_ssl_get_extension_mask( unsigned int extension_type ); |
| 121 | /* Macros used to define mask constants */ |
| 122 | #define MBEDTLS_SSL_EXT_MASK( id ) ( 1ULL << ( MBEDTLS_SSL_EXT_ID_##id ) ) |
| 123 | /* Reset value of extension mask */ |
| 124 | #define MBEDTLS_SSL_EXT_MASK_NONE 0 |
Jerry Yu | 93bcd61 | 2021-08-18 12:47:24 +0800 | [diff] [blame] | 125 | |
Jerry Yu | c4bf5d6 | 2022-10-29 09:08:47 +0800 | [diff] [blame] | 126 | /* In messages containing extension requests, we should ignore unrecognized |
| 127 | * extensions. In messages containing extension responses, unrecognized |
| 128 | * extensions should result in handshake abortion. Messages containing |
| 129 | * extension requests include ClientHello, CertificateRequest and |
| 130 | * NewSessionTicket. Messages containing extension responses include |
| 131 | * ServerHello, HelloRetryRequest, EncryptedExtensions and Certificate. |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 132 | * |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 133 | * RFC 8446 section 4.1.3 |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 134 | * |
| 135 | * The ServerHello MUST only include extensions which are required to establish |
| 136 | * the cryptographic context and negotiate the protocol version. |
| 137 | * |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 138 | * RFC 8446 section 4.2 |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 139 | * |
| 140 | * If an implementation receives an extension which it recognizes and which is |
| 141 | * not specified for the message in which it appears, it MUST abort the handshake |
| 142 | * with an "illegal_parameter" alert. |
| 143 | */ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 144 | |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 145 | /* Extensions that are not recognized by TLS 1.3 */ |
| 146 | #define MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 147 | ( MBEDTLS_SSL_EXT_MASK( SUPPORTED_POINT_FORMATS ) | \ |
| 148 | MBEDTLS_SSL_EXT_MASK( ENCRYPT_THEN_MAC ) | \ |
| 149 | MBEDTLS_SSL_EXT_MASK( EXTENDED_MASTER_SECRET ) | \ |
| 150 | MBEDTLS_SSL_EXT_MASK( SESSION_TICKET ) | \ |
Jerry Yu | b95dd36 | 2022-11-08 21:19:34 +0800 | [diff] [blame] | 151 | MBEDTLS_SSL_EXT_MASK( TRUNCATED_HMAC ) | \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 152 | MBEDTLS_SSL_EXT_MASK( UNRECOGNIZED ) ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 153 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 154 | /* RFC 8446 section 4.2. Allowed extensions for ClienHello */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 155 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 156 | ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \ |
| 157 | MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \ |
| 158 | MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \ |
| 159 | MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \ |
| 160 | MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \ |
| 161 | MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \ |
| 162 | MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \ |
| 163 | MBEDTLS_SSL_EXT_MASK( ALPN ) | \ |
| 164 | MBEDTLS_SSL_EXT_MASK( SCT ) | \ |
| 165 | MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \ |
| 166 | MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \ |
| 167 | MBEDTLS_SSL_EXT_MASK( PADDING ) | \ |
| 168 | MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \ |
| 169 | MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \ |
| 170 | MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) | \ |
| 171 | MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \ |
| 172 | MBEDTLS_SSL_EXT_MASK( COOKIE ) | \ |
| 173 | MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) | \ |
| 174 | MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \ |
| 175 | MBEDTLS_SSL_EXT_MASK( POST_HANDSHAKE_AUTH ) | \ |
| 176 | MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \ |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 177 | MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 178 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 179 | /* RFC 8446 section 4.2. Allowed extensions for EncryptedExtensions */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 180 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 181 | ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \ |
| 182 | MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \ |
| 183 | MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \ |
| 184 | MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \ |
| 185 | MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \ |
| 186 | MBEDTLS_SSL_EXT_MASK( ALPN ) | \ |
| 187 | MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \ |
| 188 | MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \ |
| 189 | MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 190 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 191 | /* RFC 8446 section 4.2. Allowed extensions for CertificateRequest */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 192 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 193 | ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \ |
| 194 | MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \ |
| 195 | MBEDTLS_SSL_EXT_MASK( SCT ) | \ |
| 196 | MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \ |
| 197 | MBEDTLS_SSL_EXT_MASK( OID_FILTERS ) | \ |
| 198 | MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \ |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 199 | MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 200 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 201 | /* RFC 8446 section 4.2. Allowed extensions for Certificate */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 202 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 203 | ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \ |
| 204 | MBEDTLS_SSL_EXT_MASK( SCT ) ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 205 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 206 | /* RFC 8446 section 4.2. Allowed extensions for ServerHello */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 207 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 208 | ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \ |
| 209 | MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \ |
| 210 | MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 211 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 212 | /* RFC 8446 section 4.2. Allowed extensions for HelloRetryRequest */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 213 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 214 | ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \ |
| 215 | MBEDTLS_SSL_EXT_MASK( COOKIE ) | \ |
| 216 | MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 217 | |
Jerry Yu | d15992d | 2022-08-29 10:58:31 +0800 | [diff] [blame] | 218 | /* RFC 8446 section 4.2. Allowed extensions for NewSessionTicket */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 219 | #define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST \ |
Jerry Yu | df0ad65 | 2022-10-31 13:20:57 +0800 | [diff] [blame] | 220 | ( MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \ |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 221 | MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED ) |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 222 | |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 223 | /* |
Jerry Yu | 8c02bb4 | 2021-09-03 21:09:22 +0800 | [diff] [blame] | 224 | * Helper macros for function call with return check. |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 225 | */ |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 226 | /* |
Jerry Yu | 8c02bb4 | 2021-09-03 21:09:22 +0800 | [diff] [blame] | 227 | * Exit when return non-zero value |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 228 | */ |
Jerry Yu | 2c0fbf3 | 2021-09-02 13:53:46 +0800 | [diff] [blame] | 229 | #define MBEDTLS_SSL_PROC_CHK( f ) \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 230 | do { \ |
Jerry Yu | 2c0fbf3 | 2021-09-02 13:53:46 +0800 | [diff] [blame] | 231 | ret = ( f ); \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 232 | if( ret != 0 ) \ |
| 233 | { \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 234 | goto cleanup; \ |
| 235 | } \ |
| 236 | } while( 0 ) |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 237 | /* |
Jerry Yu | 8c02bb4 | 2021-09-03 21:09:22 +0800 | [diff] [blame] | 238 | * Exit when return negative value |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 239 | */ |
Jerry Yu | 2c0fbf3 | 2021-09-02 13:53:46 +0800 | [diff] [blame] | 240 | #define MBEDTLS_SSL_PROC_CHK_NEG( f ) \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 241 | do { \ |
Jerry Yu | 2c0fbf3 | 2021-09-02 13:53:46 +0800 | [diff] [blame] | 242 | ret = ( f ); \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 243 | if( ret < 0 ) \ |
| 244 | { \ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 245 | goto cleanup; \ |
| 246 | } \ |
| 247 | } while( 0 ) |
| 248 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 249 | /* |
| 250 | * DTLS retransmission states, see RFC 6347 4.2.4 |
| 251 | * |
| 252 | * The SENDING state is merged in PREPARING for initial sends, |
| 253 | * but is distinct for resends. |
| 254 | * |
| 255 | * Note: initial state is wrong for server, but is not used anyway. |
| 256 | */ |
| 257 | #define MBEDTLS_SSL_RETRANS_PREPARING 0 |
| 258 | #define MBEDTLS_SSL_RETRANS_SENDING 1 |
| 259 | #define MBEDTLS_SSL_RETRANS_WAITING 2 |
| 260 | #define MBEDTLS_SSL_RETRANS_FINISHED 3 |
| 261 | |
| 262 | /* |
| 263 | * Allow extra bytes for record, authentication and encryption overhead: |
Mateusz Starzyk | a3a9984 | 2021-02-19 14:27:22 +0100 | [diff] [blame] | 264 | * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256). |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 265 | */ |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 266 | |
TRodziewicz | 4ca18aa | 2021-05-20 14:46:20 +0200 | [diff] [blame] | 267 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Hanno Becker | 0cc4661 | 2020-11-30 08:56:52 +0000 | [diff] [blame] | 268 | |
Manuel Pégourié-Gonnard | 05579c4 | 2020-07-31 12:53:39 +0200 | [diff] [blame] | 269 | /* This macro determines whether CBC is supported. */ |
Manuel Pégourié-Gonnard | 2df1f1f | 2020-07-09 12:11:39 +0200 | [diff] [blame] | 270 | #if defined(MBEDTLS_CIPHER_MODE_CBC) && \ |
| 271 | ( defined(MBEDTLS_AES_C) || \ |
| 272 | defined(MBEDTLS_CAMELLIA_C) || \ |
| 273 | defined(MBEDTLS_ARIA_C) || \ |
| 274 | defined(MBEDTLS_DES_C) ) |
| 275 | #define MBEDTLS_SSL_SOME_SUITES_USE_CBC |
| 276 | #endif |
| 277 | |
Hanno Becker | 0cc4661 | 2020-11-30 08:56:52 +0000 | [diff] [blame] | 278 | /* This macro determines whether a ciphersuite using a |
| 279 | * stream cipher can be used. */ |
| 280 | #if defined(MBEDTLS_CIPHER_NULL_CIPHER) |
| 281 | #define MBEDTLS_SSL_SOME_SUITES_USE_STREAM |
| 282 | #endif |
| 283 | |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 284 | /* This macro determines whether the CBC construct used in TLS 1.2 is supported. */ |
Manuel Pégourié-Gonnard | ed0e864 | 2020-07-21 11:20:30 +0200 | [diff] [blame] | 285 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \ |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 286 | defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Manuel Pégourié-Gonnard | ed0e864 | 2020-07-21 11:20:30 +0200 | [diff] [blame] | 287 | #define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC |
| 288 | #endif |
| 289 | |
Hanno Becker | 31351ce | 2021-03-22 11:05:58 +0000 | [diff] [blame] | 290 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \ |
Manuel Pégourié-Gonnard | 2df1f1f | 2020-07-09 12:11:39 +0200 | [diff] [blame] | 291 | defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 292 | #define MBEDTLS_SSL_SOME_SUITES_USE_MAC |
Hanno Becker | 52344c2 | 2018-01-03 15:24:20 +0000 | [diff] [blame] | 293 | #endif |
| 294 | |
Neil Armstrong | f2c82f0 | 2022-04-05 11:16:53 +0200 | [diff] [blame] | 295 | /* This macro determines whether a ciphersuite uses Encrypt-then-MAC with CBC */ |
| 296 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \ |
| 297 | defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
| 298 | #define MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM |
| 299 | #endif |
| 300 | |
TRodziewicz | 4ca18aa | 2021-05-20 14:46:20 +0200 | [diff] [blame] | 301 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
Hanno Becker | 0cc4661 | 2020-11-30 08:56:52 +0000 | [diff] [blame] | 302 | |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 303 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 304 | /* Ciphersuites using HMAC */ |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 305 | #if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 306 | #define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */ |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 307 | #elif defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 308 | #define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */ |
| 309 | #else |
| 310 | #define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */ |
| 311 | #endif |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 312 | #else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */ |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 313 | /* AEAD ciphersuites: GCM and CCM use a 128 bits tag */ |
| 314 | #define MBEDTLS_SSL_MAC_ADD 16 |
| 315 | #endif |
| 316 | |
| 317 | #if defined(MBEDTLS_CIPHER_MODE_CBC) |
| 318 | #define MBEDTLS_SSL_PADDING_ADD 256 |
| 319 | #else |
| 320 | #define MBEDTLS_SSL_PADDING_ADD 0 |
| 321 | #endif |
| 322 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 323 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 324 | #define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 325 | #else |
| 326 | #define MBEDTLS_SSL_MAX_CID_EXPANSION 0 |
| 327 | #endif |
| 328 | |
Mateusz Starzyk | a3a9984 | 2021-02-19 14:27:22 +0100 | [diff] [blame] | 329 | #define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 330 | MBEDTLS_SSL_MAC_ADD + \ |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 331 | MBEDTLS_SSL_PADDING_ADD + \ |
| 332 | MBEDTLS_SSL_MAX_CID_EXPANSION \ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 333 | ) |
| 334 | |
| 335 | #define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \ |
| 336 | ( MBEDTLS_SSL_IN_CONTENT_LEN ) ) |
| 337 | |
| 338 | #define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \ |
| 339 | ( MBEDTLS_SSL_OUT_CONTENT_LEN ) ) |
| 340 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 341 | /* The maximum number of buffered handshake messages. */ |
Hanno Becker | d488b9e | 2018-08-16 16:35:37 +0100 | [diff] [blame] | 342 | #define MBEDTLS_SSL_MAX_BUFFERED_HS 4 |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 343 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 344 | /* Maximum length we can advertise as our max content length for |
| 345 | RFC 6066 max_fragment_length extension negotiation purposes |
| 346 | (the lesser of both sizes, if they are unequal.) |
| 347 | */ |
| 348 | #define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \ |
| 349 | (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \ |
| 350 | ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \ |
| 351 | : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \ |
| 352 | ) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 353 | |
Jerry Yu | 4131ec1 | 2022-01-19 10:36:30 +0800 | [diff] [blame] | 354 | /* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */ |
| 355 | #define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534 |
| 356 | |
Jerry Yu | 8afd6e4 | 2022-01-20 15:54:26 +0800 | [diff] [blame] | 357 | /* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */ |
Jerry Yu | 4131ec1 | 2022-01-19 10:36:30 +0800 | [diff] [blame] | 358 | #define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2 |
Hanno Becker | e131bfe | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 359 | |
| 360 | /* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */ |
| 361 | #define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535 |
| 362 | |
Xiaofei Bai | f5b4d25 | 2022-01-28 06:37:15 +0000 | [diff] [blame] | 363 | #define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20 |
Xiaofei Bai | 82f0a9a | 2022-01-26 09:21:54 +0000 | [diff] [blame] | 364 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 365 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Gabor Mezei | 15b95a6 | 2022-05-09 16:37:58 +0200 | [diff] [blame] | 366 | |
Gabor Mezei | 24c7c2b | 2022-05-10 12:51:14 +0200 | [diff] [blame] | 367 | #define MBEDTLS_TLS_SIG_NONE MBEDTLS_TLS1_3_SIG_NONE |
| 368 | |
Gabor Mezei | 15b95a6 | 2022-05-09 16:37:58 +0200 | [diff] [blame] | 369 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Gabor Mezei | 3631cf6 | 2022-05-10 12:59:00 +0200 | [diff] [blame] | 370 | #define MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( sig, hash ) (( hash << 8 ) | sig) |
| 371 | #define MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg & 0xFF) |
| 372 | #define MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg >> 8) |
Gabor Mezei | 15b95a6 | 2022-05-09 16:37:58 +0200 | [diff] [blame] | 373 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 374 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 375 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Gabor Mezei | 15b95a6 | 2022-05-09 16:37:58 +0200 | [diff] [blame] | 376 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 377 | /* |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 378 | * Check that we obey the standard's message size bounds |
| 379 | */ |
| 380 | |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 381 | #if MBEDTLS_SSL_IN_CONTENT_LEN > 16384 |
| 382 | #error "Bad configuration - incoming record content too large." |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 383 | #endif |
| 384 | |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 385 | #if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384 |
| 386 | #error "Bad configuration - outgoing record content too large." |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 387 | #endif |
| 388 | |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 389 | #if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048 |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 390 | #error "Bad configuration - incoming protected record payload too large." |
| 391 | #endif |
| 392 | |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 393 | #if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048 |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 394 | #error "Bad configuration - outgoing protected record payload too large." |
| 395 | #endif |
| 396 | |
| 397 | /* Calculate buffer sizes */ |
| 398 | |
Hanno Becker | 25d6d1a | 2017-12-07 08:22:51 +0000 | [diff] [blame] | 399 | /* Note: Even though the TLS record header is only 5 bytes |
| 400 | long, we're internally using 8 bytes to store the |
| 401 | implicit sequence number. */ |
Hanno Becker | d25d444 | 2017-10-04 13:56:42 +0100 | [diff] [blame] | 402 | #define MBEDTLS_SSL_HEADER_LEN 13 |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 403 | |
Andrzej Kurek | 033c42a | 2020-03-03 05:57:59 -0500 | [diff] [blame] | 404 | #if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 405 | #define MBEDTLS_SSL_IN_BUFFER_LEN \ |
| 406 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) ) |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 407 | #else |
| 408 | #define MBEDTLS_SSL_IN_BUFFER_LEN \ |
| 409 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \ |
| 410 | + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) ) |
| 411 | #endif |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 412 | |
Andrzej Kurek | 033c42a | 2020-03-03 05:57:59 -0500 | [diff] [blame] | 413 | #if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 414 | #define MBEDTLS_SSL_OUT_BUFFER_LEN \ |
| 415 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) ) |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 416 | #else |
| 417 | #define MBEDTLS_SSL_OUT_BUFFER_LEN \ |
| 418 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \ |
| 419 | + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) ) |
| 420 | #endif |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 421 | |
Jerry Yu | e6d7e5c | 2021-10-26 10:44:32 +0800 | [diff] [blame] | 422 | #define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32 |
| 423 | #define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32 |
| 424 | |
Hanno Becker | 9752aad | 2021-04-21 05:54:33 +0100 | [diff] [blame] | 425 | #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) |
| 426 | /** |
| 427 | * \brief Return the maximum fragment length (payload, in bytes) for |
| 428 | * the output buffer. For the client, this is the configured |
| 429 | * value. For the server, it is the minimum of two - the |
| 430 | * configured value and the negotiated one. |
| 431 | * |
| 432 | * \sa mbedtls_ssl_conf_max_frag_len() |
| 433 | * \sa mbedtls_ssl_get_max_out_record_payload() |
| 434 | * |
| 435 | * \param ssl SSL context |
| 436 | * |
| 437 | * \return Current maximum fragment length for the output buffer. |
| 438 | */ |
| 439 | size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl ); |
| 440 | |
| 441 | /** |
| 442 | * \brief Return the maximum fragment length (payload, in bytes) for |
| 443 | * the input buffer. This is the negotiated maximum fragment |
Hanno Becker | df3b863 | 2021-06-08 05:30:45 +0100 | [diff] [blame] | 444 | * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN. |
Hanno Becker | 9752aad | 2021-04-21 05:54:33 +0100 | [diff] [blame] | 445 | * If it is not defined either, the value is 2^14. This function |
| 446 | * works as its predecessor, \c mbedtls_ssl_get_max_frag_len(). |
| 447 | * |
| 448 | * \sa mbedtls_ssl_conf_max_frag_len() |
| 449 | * \sa mbedtls_ssl_get_max_in_record_payload() |
| 450 | * |
| 451 | * \param ssl SSL context |
| 452 | * |
| 453 | * \return Current maximum fragment length for the output buffer. |
| 454 | */ |
| 455 | size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl ); |
| 456 | #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ |
| 457 | |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 458 | #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 459 | static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 460 | { |
| 461 | #if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 462 | return mbedtls_ssl_get_output_max_frag_len( ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 463 | + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD |
| 464 | + MBEDTLS_SSL_CID_OUT_LEN_MAX; |
| 465 | #else |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 466 | return mbedtls_ssl_get_output_max_frag_len( ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 467 | + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD; |
| 468 | #endif |
| 469 | } |
| 470 | |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 471 | static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 472 | { |
| 473 | #if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 474 | return mbedtls_ssl_get_input_max_frag_len( ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 475 | + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD |
| 476 | + MBEDTLS_SSL_CID_IN_LEN_MAX; |
| 477 | #else |
Andrzej Kurek | 069fa96 | 2021-01-07 08:02:15 -0500 | [diff] [blame] | 478 | return mbedtls_ssl_get_input_max_frag_len( ctx ) |
Andrzej Kurek | 0afa2a1 | 2020-03-03 10:39:58 -0500 | [diff] [blame] | 479 | + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD; |
| 480 | #endif |
| 481 | } |
| 482 | #endif |
| 483 | |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 484 | /* |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 485 | * TLS extension flags (for extensions with outgoing ServerHello content |
| 486 | * that need it (e.g. for RENEGOTIATION_INFO the server already knows because |
| 487 | * of state of the renegotiation flag, so no indicator is required) |
| 488 | */ |
| 489 | #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0) |
Manuel Pégourié-Gonnard | bf57be6 | 2015-09-16 15:04:01 +0200 | [diff] [blame] | 490 | #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 491 | |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 492 | /** |
| 493 | * \brief This function checks if the remaining size in a buffer is |
| 494 | * greater or equal than a needed space. |
| 495 | * |
| 496 | * \param cur Pointer to the current position in the buffer. |
| 497 | * \param end Pointer to one past the end of the buffer. |
| 498 | * \param need Needed space in bytes. |
| 499 | * |
Ronald Cron | b7b35e1 | 2020-06-11 09:50:51 +0200 | [diff] [blame] | 500 | * \return Zero if the needed space is available in the buffer, non-zero |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 501 | * otherwise. |
| 502 | */ |
Ronald Cron | ad8c17b | 2022-06-10 17:18:09 +0200 | [diff] [blame] | 503 | #if ! defined(MBEDTLS_TEST_HOOKS) |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 504 | static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur, |
| 505 | const uint8_t *end, size_t need ) |
| 506 | { |
Ronald Cron | b7b35e1 | 2020-06-11 09:50:51 +0200 | [diff] [blame] | 507 | return( ( cur > end ) || ( need > (size_t)( end - cur ) ) ); |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 508 | } |
Ronald Cron | ad8c17b | 2022-06-10 17:18:09 +0200 | [diff] [blame] | 509 | #else |
| 510 | typedef struct |
| 511 | { |
| 512 | const uint8_t *cur; |
| 513 | const uint8_t *end; |
| 514 | size_t need; |
| 515 | } mbedtls_ssl_chk_buf_ptr_args; |
| 516 | |
| 517 | void mbedtls_ssl_set_chk_buf_ptr_fail_args( |
| 518 | const uint8_t *cur, const uint8_t *end, size_t need ); |
| 519 | void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void ); |
Ronald Cron | ce7d76e | 2022-07-08 18:56:49 +0200 | [diff] [blame] | 520 | |
| 521 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | ad8c17b | 2022-06-10 17:18:09 +0200 | [diff] [blame] | 522 | int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args ); |
| 523 | |
| 524 | static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur, |
| 525 | const uint8_t *end, size_t need ) |
| 526 | { |
| 527 | if( ( cur > end ) || ( need > (size_t)( end - cur ) ) ) |
| 528 | { |
| 529 | mbedtls_ssl_set_chk_buf_ptr_fail_args( cur, end, need ); |
| 530 | return( 1 ); |
| 531 | } |
| 532 | return( 0 ); |
| 533 | } |
Ronald Cron | cf600bc | 2022-06-17 15:54:16 +0200 | [diff] [blame] | 534 | #endif /* MBEDTLS_TEST_HOOKS */ |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 535 | |
| 536 | /** |
| 537 | * \brief This macro checks if the remaining size in a buffer is |
| 538 | * greater or equal than a needed space. If it is not the case, |
| 539 | * it returns an SSL_BUFFER_TOO_SMALL error. |
| 540 | * |
| 541 | * \param cur Pointer to the current position in the buffer. |
| 542 | * \param end Pointer to one past the end of the buffer. |
| 543 | * \param need Needed space in bytes. |
| 544 | * |
| 545 | */ |
| 546 | #define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \ |
| 547 | do { \ |
Ronald Cron | b7b35e1 | 2020-06-11 09:50:51 +0200 | [diff] [blame] | 548 | if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \ |
Hanno Becker | 51018aa | 2017-04-12 14:54:42 +0100 | [diff] [blame] | 549 | { \ |
| 550 | return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \ |
| 551 | } \ |
| 552 | } while( 0 ) |
| 553 | |
Jerry Yu | 34da372 | 2021-09-19 18:05:08 +0800 | [diff] [blame] | 554 | /** |
Jerry Yu | e15e665 | 2021-09-28 21:06:07 +0800 | [diff] [blame] | 555 | * \brief This macro checks if the remaining length in an input buffer is |
| 556 | * greater or equal than a needed length. If it is not the case, it |
Jerry Yu | 205fd82 | 2021-10-08 16:16:24 +0800 | [diff] [blame] | 557 | * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a |
Jerry Yu | dca3d5d | 2021-10-08 14:19:29 +0800 | [diff] [blame] | 558 | * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message. |
Jerry Yu | e4eefc7 | 2021-10-09 10:40:40 +0800 | [diff] [blame] | 559 | * |
| 560 | * This is a function-like macro. It is guaranteed to evaluate each |
| 561 | * argument exactly once. |
Jerry Yu | 34da372 | 2021-09-19 18:05:08 +0800 | [diff] [blame] | 562 | * |
| 563 | * \param cur Pointer to the current position in the buffer. |
| 564 | * \param end Pointer to one past the end of the buffer. |
Jerry Yu | e15e665 | 2021-09-28 21:06:07 +0800 | [diff] [blame] | 565 | * \param need Needed length in bytes. |
Jerry Yu | 34da372 | 2021-09-19 18:05:08 +0800 | [diff] [blame] | 566 | * |
| 567 | */ |
| 568 | #define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \ |
| 569 | do { \ |
| 570 | if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \ |
| 571 | { \ |
| 572 | MBEDTLS_SSL_DEBUG_MSG( 1, \ |
| 573 | ( "missing input data in %s", __func__ ) ); \ |
| 574 | MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \ |
| 575 | MBEDTLS_ERR_SSL_DECODE_ERROR ); \ |
| 576 | return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \ |
| 577 | } \ |
| 578 | } while( 0 ) |
| 579 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 580 | #ifdef __cplusplus |
| 581 | extern "C" { |
| 582 | #endif |
| 583 | |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 584 | typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen, |
| 585 | const char *label, |
| 586 | const unsigned char *random, size_t rlen, |
| 587 | unsigned char *dstbuf, size_t dlen ); |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 588 | |
Hanno Becker | 61baae7 | 2020-09-16 09:24:14 +0100 | [diff] [blame] | 589 | /* cipher.h exports the maximum IV, key and block length from |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 590 | * all ciphers enabled in the config, regardless of whether those |
| 591 | * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled |
| 592 | * in the default configuration and uses 64 Byte keys, but it is |
| 593 | * not used for record protection in SSL/TLS. |
| 594 | * |
| 595 | * In order to prevent unnecessary inflation of key structures, |
| 596 | * we introduce SSL-specific variants of the max-{key,block,IV} |
| 597 | * macros here which are meant to only take those ciphers into |
| 598 | * account which can be negotiated in SSL/TLS. |
| 599 | * |
| 600 | * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH |
| 601 | * in cipher.h are rough overapproximations of the real maxima, here |
Hanno Becker | 9a7a2ac | 2020-09-09 09:24:54 +0100 | [diff] [blame] | 602 | * we content ourselves with replicating those overapproximations |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 603 | * for the maximum block and IV length, and excluding XTS from the |
| 604 | * computation of the maximum key length. */ |
| 605 | #define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16 |
| 606 | #define MBEDTLS_SSL_MAX_IV_LENGTH 16 |
| 607 | #define MBEDTLS_SSL_MAX_KEY_LENGTH 32 |
| 608 | |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 609 | /** |
| 610 | * \brief The data structure holding the cryptographic material (key and IV) |
| 611 | * used for record protection in TLS 1.3. |
| 612 | */ |
| 613 | struct mbedtls_ssl_key_set |
| 614 | { |
| 615 | /*! The key for client->server records. */ |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 616 | unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ]; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 617 | /*! The key for server->client records. */ |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 618 | unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ]; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 619 | /*! The IV for client->server records. */ |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 620 | unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ]; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 621 | /*! The IV for server->client records. */ |
Hanno Becker | 1588983 | 2020-09-08 11:29:11 +0100 | [diff] [blame] | 622 | unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ]; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 623 | |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 624 | size_t key_len; /*!< The length of client_write_key and |
| 625 | * server_write_key, in Bytes. */ |
| 626 | size_t iv_len; /*!< The length of client_write_iv and |
| 627 | * server_write_iv, in Bytes. */ |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 628 | }; |
| 629 | typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 630 | |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 631 | typedef struct |
| 632 | { |
Jerry Yu | f532bb2 | 2021-10-13 10:34:03 +0800 | [diff] [blame] | 633 | unsigned char binder_key [ MBEDTLS_TLS1_3_MD_MAX_SIZE ]; |
| 634 | unsigned char client_early_traffic_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ]; |
| 635 | unsigned char early_exporter_master_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ]; |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 636 | } mbedtls_ssl_tls13_early_secrets; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 637 | |
| 638 | typedef struct |
| 639 | { |
Jerry Yu | f532bb2 | 2021-10-13 10:34:03 +0800 | [diff] [blame] | 640 | unsigned char client_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ]; |
| 641 | unsigned char server_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ]; |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 642 | } mbedtls_ssl_tls13_handshake_secrets; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 643 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 644 | /* |
| 645 | * This structure contains the parameters only needed during handshake. |
| 646 | */ |
| 647 | struct mbedtls_ssl_handshake_params |
| 648 | { |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 649 | /* Frequently-used boolean or byte fields (placed early to take |
| 650 | * advantage of smaller code size for indirect access on Arm Thumb) */ |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 651 | uint8_t resume; /*!< session resume indicator*/ |
| 652 | uint8_t cli_exts; /*!< client extension presence*/ |
| 653 | |
Glenn Strauss | bbdc83b | 2022-04-12 07:31:46 -0400 | [diff] [blame] | 654 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
| 655 | uint8_t sni_authmode; /*!< authmode from SNI callback */ |
| 656 | #endif |
| 657 | |
XiaokangQian | 189ded2 | 2022-05-10 08:12:17 +0000 | [diff] [blame] | 658 | #if defined(MBEDTLS_SSL_SRV_C) |
XiaokangQian | c3017f6 | 2022-05-13 05:55:41 +0000 | [diff] [blame] | 659 | /* Flag indicating if a CertificateRequest message has been sent |
| 660 | * to the client or not. */ |
XiaokangQian | 63e713e | 2022-05-15 04:26:57 +0000 | [diff] [blame] | 661 | uint8_t certificate_request_sent; |
XiaokangQian | 189ded2 | 2022-05-10 08:12:17 +0000 | [diff] [blame] | 662 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 663 | |
Glenn Strauss | bbdc83b | 2022-04-12 07:31:46 -0400 | [diff] [blame] | 664 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) |
| 665 | uint8_t new_session_ticket; /*!< use NewSessionTicket? */ |
| 666 | #endif /* MBEDTLS_SSL_SESSION_TICKETS */ |
| 667 | |
Ronald Cron | 82c785f | 2022-03-31 15:44:41 +0200 | [diff] [blame] | 668 | #if defined(MBEDTLS_SSL_CLI_C) |
Ronald Cron | 217d699 | 2022-04-04 10:23:22 +0200 | [diff] [blame] | 669 | /** Minimum TLS version to be negotiated. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 670 | * |
Ronald Cron | 217d699 | 2022-04-04 10:23:22 +0200 | [diff] [blame] | 671 | * It is set up in the ClientHello writing preparation stage and used |
| 672 | * throughout the ClientHello writing. Not relevant anymore as soon as |
| 673 | * the protocol version has been negotiated thus as soon as the |
| 674 | * ServerHello is received. |
| 675 | * For a fresh handshake not linked to any previous handshake, it is |
| 676 | * equal to the configured minimum minor version to be negotiated. When |
| 677 | * renegotiating or resuming a session, it is equal to the previously |
| 678 | * negotiated minor version. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 679 | * |
Ronald Cron | 217d699 | 2022-04-04 10:23:22 +0200 | [diff] [blame] | 680 | * There is no maximum TLS version field in this handshake context. |
| 681 | * From the start of the handshake, we need to define a current protocol |
| 682 | * version for the record layer which we define as the maximum TLS |
| 683 | * version to be negotiated. The `tls_version` field of the SSL context is |
| 684 | * used to store this maximum value until it contains the actual |
| 685 | * negotiated value. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 686 | */ |
Glenn Strauss | bbdc83b | 2022-04-12 07:31:46 -0400 | [diff] [blame] | 687 | mbedtls_ssl_protocol_version min_tls_version; |
Ronald Cron | 82c785f | 2022-03-31 15:44:41 +0200 | [diff] [blame] | 688 | #endif |
Ronald Cron | 86a477f | 2022-02-18 17:45:10 +0100 | [diff] [blame] | 689 | |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 690 | #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) |
| 691 | uint8_t extended_ms; /*!< use Extended Master Secret? */ |
| 692 | #endif |
| 693 | |
| 694 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
| 695 | uint8_t async_in_progress; /*!< an asynchronous operation is in progress */ |
| 696 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
| 697 | |
| 698 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 699 | unsigned char retransmit_state; /*!< Retransmission state */ |
| 700 | #endif |
| 701 | |
Gilles Peskine | 41139a2 | 2021-12-08 18:25:39 +0100 | [diff] [blame] | 702 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
| 703 | unsigned char group_list_heap_allocated; |
Jerry Yu | f017ee4 | 2022-01-12 15:49:48 +0800 | [diff] [blame] | 704 | unsigned char sig_algs_heap_allocated; |
Gilles Peskine | 41139a2 | 2021-12-08 18:25:39 +0100 | [diff] [blame] | 705 | #endif |
| 706 | |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 707 | #if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED) |
| 708 | uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */ |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 709 | enum { /* this complements ssl->state with info on intra-state operations */ |
| 710 | ssl_ecrs_none = 0, /*!< nothing going on (yet) */ |
| 711 | ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */ |
| 712 | ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */ |
| 713 | ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */ |
| 714 | ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */ |
| 715 | } ecrs_state; /*!< current (or last) operation */ |
| 716 | mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */ |
| 717 | size_t ecrs_n; /*!< place for saving a length */ |
| 718 | #endif |
| 719 | |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 720 | mbedtls_ssl_ciphersuite_t const *ciphersuite_info; |
| 721 | |
| 722 | void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t); |
| 723 | void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *); |
| 724 | void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int); |
| 725 | mbedtls_ssl_tls_prf_cb *tls_prf; |
| 726 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 727 | /* |
| 728 | * Handshake specific crypto variables |
| 729 | */ |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 730 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Ronald Cron | 8538549 | 2022-07-20 16:44:00 +0200 | [diff] [blame] | 731 | uint8_t key_exchange_mode; /*!< Selected key exchange mode */ |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 732 | |
Jerry Yu | 6a2cd9e | 2022-05-05 11:14:19 +0800 | [diff] [blame] | 733 | /** Number of HelloRetryRequest messages received/sent from/to the server. */ |
XiaokangQian | d9e068e | 2022-01-18 06:23:32 +0000 | [diff] [blame] | 734 | int hello_retry_request_count; |
Ronald Cron | bc817ba | 2022-07-21 09:35:20 +0200 | [diff] [blame] | 735 | |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 736 | #if defined(MBEDTLS_SSL_SRV_C) |
XiaokangQian | 318dc76 | 2022-04-20 09:43:51 +0000 | [diff] [blame] | 737 | /** selected_group of key_share extension in HelloRetryRequest message. */ |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 738 | uint16_t hrr_selected_group; |
Ronald Cron | 41a443a | 2022-10-04 16:38:25 +0200 | [diff] [blame] | 739 | #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED) |
Ronald Cron | bc817ba | 2022-07-21 09:35:20 +0200 | [diff] [blame] | 740 | uint8_t tls13_kex_modes; /*!< Key exchange modes supported by the client */ |
| 741 | #endif |
Jerry Yu | d4e7500 | 2022-08-09 13:33:50 +0800 | [diff] [blame] | 742 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) |
Jerry Yu | f3bdf9d | 2022-09-22 23:30:49 +0800 | [diff] [blame] | 743 | uint16_t new_session_tickets_count; /*!< number of session tickets */ |
Jerry Yu | d4e7500 | 2022-08-09 13:33:50 +0800 | [diff] [blame] | 744 | #endif |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 745 | #endif /* MBEDTLS_SSL_SRV_C */ |
Ronald Cron | bc817ba | 2022-07-21 09:35:20 +0200 | [diff] [blame] | 746 | |
Jerry Yu | 582dd06 | 2022-04-22 21:59:01 +0800 | [diff] [blame] | 747 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 748 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 749 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Xiaofei Bai | f5b4d25 | 2022-01-28 06:37:15 +0000 | [diff] [blame] | 750 | uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE]; |
| 751 | #endif |
| 752 | |
Gilles Peskine | 41139a2 | 2021-12-08 18:25:39 +0100 | [diff] [blame] | 753 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
| 754 | const uint16_t *group_list; |
Jerry Yu | f017ee4 | 2022-01-12 15:49:48 +0800 | [diff] [blame] | 755 | const uint16_t *sig_algs; |
Gilles Peskine | 41139a2 | 2021-12-08 18:25:39 +0100 | [diff] [blame] | 756 | #endif |
| 757 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 758 | #if defined(MBEDTLS_DHM_C) |
| 759 | mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */ |
| 760 | #endif |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 761 | |
John Durkop | 07cc04a | 2020-11-16 22:08:34 -0800 | [diff] [blame] | 762 | /* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 763 | * to guards in client and server code. There is a gap in functionality that |
| 764 | * access to ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not |
| 765 | * seem correct. |
John Durkop | 07cc04a | 2020-11-16 22:08:34 -0800 | [diff] [blame] | 766 | */ |
| 767 | #if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) |
Neil Armstrong | 769dc05 | 2022-04-13 15:12:43 +0200 | [diff] [blame] | 768 | #if !defined(MBEDTLS_USE_PSA_CRYPTO) |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 769 | mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */ |
Neil Armstrong | 769dc05 | 2022-04-13 15:12:43 +0200 | [diff] [blame] | 770 | #endif /* !MBEDTLS_USE_PSA_CRYPTO */ |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 771 | |
Przemyslaw Stekiel | b15f33d | 2022-02-10 10:12:12 +0100 | [diff] [blame] | 772 | #if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Gilles Peskine | 4245980 | 2019-12-19 13:31:53 +0100 | [diff] [blame] | 773 | psa_key_type_t ecdh_psa_type; |
Neil Armstrong | 91477a7 | 2022-03-25 15:42:20 +0100 | [diff] [blame] | 774 | size_t ecdh_bits; |
Andrzej Kurek | 03e0146 | 2022-01-03 12:53:24 +0100 | [diff] [blame] | 775 | mbedtls_svc_key_id_t ecdh_psa_privkey; |
Neil Armstrong | f716a70 | 2022-04-04 11:23:46 +0200 | [diff] [blame] | 776 | uint8_t ecdh_psa_privkey_is_external; |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 777 | unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH]; |
| 778 | size_t ecdh_psa_peerkey_len; |
Przemyslaw Stekiel | b15f33d | 2022-02-10 10:12:12 +0100 | [diff] [blame] | 779 | #endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */ |
John Durkop | 07cc04a | 2020-11-16 22:08:34 -0800 | [diff] [blame] | 780 | #endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */ |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 781 | |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 782 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Manuel Pégourié-Gonnard | 76cfd3f | 2015-09-15 12:10:54 +0200 | [diff] [blame] | 783 | mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */ |
Manuel Pégourié-Gonnard | 77c0646 | 2015-09-17 13:59:49 +0200 | [diff] [blame] | 784 | #if defined(MBEDTLS_SSL_CLI_C) |
| 785 | unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */ |
| 786 | size_t ecjpake_cache_len; /*!< Length of cached data */ |
| 787 | #endif |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 788 | #endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */ |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 789 | |
| 790 | #if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \ |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 791 | defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 792 | const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */ |
| 793 | #endif |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 794 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 795 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) |
Hanno Becker | d9f7d43 | 2018-10-22 15:29:46 +0100 | [diff] [blame] | 796 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Andrzej Kurek | 03e0146 | 2022-01-03 12:53:24 +0100 | [diff] [blame] | 797 | mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */ |
Neil Armstrong | 501c932 | 2022-05-03 09:35:09 +0200 | [diff] [blame] | 798 | uint8_t psk_opaque_is_internal; |
Neil Armstrong | e952a30 | 2022-05-03 10:22:14 +0200 | [diff] [blame] | 799 | #else |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 800 | unsigned char *psk; /*!< PSK from the callback */ |
| 801 | size_t psk_len; /*!< Length of PSK from callback */ |
Neil Armstrong | e952a30 | 2022-05-03 10:22:14 +0200 | [diff] [blame] | 802 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Jerry Yu | 96a2e36 | 2022-07-21 15:11:34 +0800 | [diff] [blame] | 803 | uint16_t selected_identity; |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 804 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */ |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 805 | |
Gilles Peskine | cfe74a3 | 2021-12-08 18:38:51 +0100 | [diff] [blame] | 806 | #if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED) |
| 807 | mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */ |
| 808 | #endif |
| 809 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 810 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 811 | mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */ |
| 812 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
| 813 | mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */ |
| 814 | mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */ |
| 815 | mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */ |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 816 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 817 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 818 | |
Gilles Peskine | 8716f17 | 2021-11-16 15:21:44 +0100 | [diff] [blame] | 819 | #if defined(MBEDTLS_X509_CRT_PARSE_C) && \ |
Hanno Becker | 7517312 | 2019-02-06 16:18:31 +0000 | [diff] [blame] | 820 | !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE) |
| 821 | mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */ |
| 822 | #endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */ |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 823 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 824 | struct |
| 825 | { |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 826 | size_t total_bytes_buffered; /*!< Cumulative size of heap allocated |
| 827 | * buffers used for message buffering. */ |
| 828 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 829 | uint8_t seen_ccs; /*!< Indicates if a CCS message has |
Hanno Becker | 2ed6bcc | 2018-08-15 15:11:57 +0100 | [diff] [blame] | 830 | * been seen in the current flight. */ |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 831 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 832 | struct mbedtls_ssl_hs_buffer |
| 833 | { |
Hanno Becker | 98081a0 | 2018-08-22 13:32:50 +0100 | [diff] [blame] | 834 | unsigned is_valid : 1; |
| 835 | unsigned is_fragmented : 1; |
| 836 | unsigned is_complete : 1; |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 837 | unsigned char *data; |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 838 | size_t data_len; |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 839 | } hs[MBEDTLS_SSL_MAX_BUFFERED_HS]; |
| 840 | |
Hanno Becker | 5f066e7 | 2018-08-16 14:56:31 +0100 | [diff] [blame] | 841 | struct |
| 842 | { |
| 843 | unsigned char *data; |
| 844 | size_t len; |
| 845 | unsigned epoch; |
| 846 | } future_record; |
| 847 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 848 | } buffering; |
Hanno Becker | 3546201 | 2018-08-22 10:25:40 +0100 | [diff] [blame] | 849 | |
XiaokangQian | 9b93c0d | 2022-02-09 06:02:25 +0000 | [diff] [blame] | 850 | #if defined(MBEDTLS_SSL_CLI_C) && \ |
| 851 | ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) ) |
| 852 | unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS |
| 853 | * HelloRetryRequest cookie for TLS 1.3 */ |
| 854 | #endif /* MBEDTLS_SSL_CLI_C && |
| 855 | ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */ |
| 856 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 857 | unsigned char verify_cookie_len; /*!< Cli: HelloVerifyRequest cookie |
| 858 | * length |
XiaokangQian | 3490974 | 2022-01-27 02:25:04 +0000 | [diff] [blame] | 859 | * Srv: flag for sending a cookie */ |
XiaokangQian | 9b93c0d | 2022-02-09 06:02:25 +0000 | [diff] [blame] | 860 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 861 | #if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3) |
| 862 | uint16_t hrr_cookie_len; /*!< HelloRetryRequest cookie length */ |
XiaokangQian | 2043897 | 2022-03-04 08:52:07 +0000 | [diff] [blame] | 863 | #endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */ |
XiaokangQian | 52da558 | 2022-01-26 09:49:29 +0000 | [diff] [blame] | 864 | |
| 865 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 866 | unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */ |
| 867 | unsigned int in_msg_seq; /*!< Incoming handshake sequence number */ |
Gilles Peskine | ec45c1e | 2021-11-29 12:18:09 +0100 | [diff] [blame] | 868 | |
| 869 | uint32_t retransmit_timeout; /*!< Current value of timeout */ |
| 870 | mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */ |
| 871 | mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */ |
| 872 | unsigned char *cur_msg_p; /*!< Position in current message */ |
| 873 | unsigned int in_flight_start_seq; /*!< Minimum message sequence in the |
| 874 | flight being received */ |
| 875 | mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for |
| 876 | resending messages */ |
| 877 | unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter |
| 878 | for resending messages */ |
| 879 | |
| 880 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
| 881 | /* The state of CID configuration in this handshake. */ |
| 882 | |
| 883 | uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension |
| 884 | * has been negotiated. Possible values are |
| 885 | * #MBEDTLS_SSL_CID_ENABLED and |
| 886 | * #MBEDTLS_SSL_CID_DISABLED. */ |
| 887 | unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */ |
| 888 | uint8_t peer_cid_len; /*!< The length of |
| 889 | * \c peer_cid. */ |
| 890 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
| 891 | |
Manuel Pégourié-Gonnard | f47a4af | 2018-08-22 10:38:52 +0200 | [diff] [blame] | 892 | uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */ |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 893 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 894 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 895 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Hanno Becker | e043d15 | 2021-08-12 06:22:32 +0100 | [diff] [blame] | 896 | /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages. |
| 897 | * Those pointers own the transforms they reference. */ |
Hanno Becker | 3aa186f | 2021-08-10 09:24:19 +0100 | [diff] [blame] | 898 | mbedtls_ssl_transform *transform_handshake; |
| 899 | mbedtls_ssl_transform *transform_earlydata; |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 900 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Hanno Becker | 3aa186f | 2021-08-10 09:24:19 +0100 | [diff] [blame] | 901 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 902 | /* |
| 903 | * Checksum contexts |
| 904 | */ |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 905 | #if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 906 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 907 | psa_hash_operation_t fin_sha256_psa; |
| 908 | #else |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 909 | mbedtls_sha256_context fin_sha256; |
| 910 | #endif |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 911 | #endif |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 912 | #if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 913 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Andrzej Kurek | 972fba5 | 2019-01-30 03:29:12 -0500 | [diff] [blame] | 914 | psa_hash_operation_t fin_sha384_psa; |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 915 | #else |
Andrzej Kurek | a242e83 | 2022-08-11 10:03:14 -0400 | [diff] [blame] | 916 | mbedtls_sha512_context fin_sha384; |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 917 | #endif |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 918 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 919 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 920 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | 56fc07f | 2021-09-01 17:48:49 +0800 | [diff] [blame] | 921 | uint16_t offered_group_id; /* The NamedGroup value for the group |
| 922 | * that is being used for ephemeral |
| 923 | * key exchange. |
| 924 | * |
| 925 | * On the client: Defaults to the first |
| 926 | * entry in the client's group list, |
| 927 | * but can be overwritten by the HRR. */ |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 928 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Jerry Yu | 56fc07f | 2021-09-01 17:48:49 +0800 | [diff] [blame] | 929 | |
Jerry Yu | fb28b88 | 2022-01-28 11:05:58 +0800 | [diff] [blame] | 930 | #if defined(MBEDTLS_SSL_CLI_C) |
Jerry Yu | 2d9a694 | 2022-02-08 21:07:10 +0800 | [diff] [blame] | 931 | uint8_t client_auth; /*!< used to check if CertificateRequest has been |
Jerry Yu | 5c7d1cc | 2022-02-08 21:08:29 +0800 | [diff] [blame] | 932 | received from server side. If CertificateRequest |
Jerry Yu | 0ff8ac8 | 2022-02-08 10:10:48 +0800 | [diff] [blame] | 933 | has been received, Certificate and CertificateVerify |
Jerry Yu | fb28b88 | 2022-01-28 11:05:58 +0800 | [diff] [blame] | 934 | should be sent to server */ |
| 935 | #endif /* MBEDTLS_SSL_CLI_C */ |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 936 | /* |
| 937 | * State-local variables used during the processing |
| 938 | * of a specific handshake state. |
| 939 | */ |
| 940 | union |
| 941 | { |
| 942 | /* Outgoing Finished message */ |
| 943 | struct |
| 944 | { |
| 945 | uint8_t preparation_done; |
| 946 | |
| 947 | /* Buffer holding digest of the handshake up to |
| 948 | * but excluding the outgoing finished message. */ |
XiaokangQian | c5c39d5 | 2021-11-09 11:55:10 +0000 | [diff] [blame] | 949 | unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 950 | size_t digest_len; |
| 951 | } finished_out; |
| 952 | |
| 953 | /* Incoming Finished message */ |
| 954 | struct |
| 955 | { |
XiaokangQian | 57b2aff | 2021-11-10 03:12:11 +0000 | [diff] [blame] | 956 | uint8_t preparation_done; |
| 957 | |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 958 | /* Buffer holding digest of the handshake up to but |
| 959 | * excluding the peer's incoming finished message. */ |
XiaokangQian | c5c39d5 | 2021-11-09 11:55:10 +0000 | [diff] [blame] | 960 | unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 961 | size_t digest_len; |
| 962 | } finished_in; |
| 963 | |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 964 | } state_local; |
| 965 | |
| 966 | /* End of state-local variables. */ |
| 967 | |
Jerry Yu | e6d7e5c | 2021-10-26 10:44:32 +0800 | [diff] [blame] | 968 | unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN + |
| 969 | MBEDTLS_SERVER_HELLO_RANDOM_LEN]; |
| 970 | /*!< random bytes */ |
Ronald Cron | 3b05620 | 2022-10-05 17:20:21 +0200 | [diff] [blame] | 971 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 972 | unsigned char premaster[MBEDTLS_PREMASTER_SIZE]; |
| 973 | /*!< premaster secret */ |
Ronald Cron | 3b05620 | 2022-10-05 17:20:21 +0200 | [diff] [blame] | 974 | size_t pmslen; /*!< premaster length */ |
| 975 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 976 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 977 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | 0c354a2 | 2022-08-29 15:25:36 +0800 | [diff] [blame] | 978 | uint32_t sent_extensions; /*!< extensions sent by endpoint */ |
| 979 | uint32_t received_extensions; /*!< extensions received by endpoint */ |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 980 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 981 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Xiaofei Bai | a0ab777 | 2022-01-16 12:14:45 +0000 | [diff] [blame] | 982 | unsigned char certificate_request_context_len; |
| 983 | unsigned char *certificate_request_context; |
Xiaofei Bai | e1e3442 | 2021-12-23 12:09:05 +0000 | [diff] [blame] | 984 | #endif |
| 985 | |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 986 | union |
| 987 | { |
Jerry Yu | d1ab262 | 2021-10-08 15:36:57 +0800 | [diff] [blame] | 988 | unsigned char early [MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
| 989 | unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
| 990 | unsigned char app [MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 991 | } tls13_master_secrets; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 992 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 993 | mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets; |
Xiaokang Qian | 0e97d4d | 2022-10-24 11:12:51 +0000 | [diff] [blame] | 994 | |
| 995 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
Xiaokang Qian | 0e97d4d | 2022-10-24 11:12:51 +0000 | [diff] [blame] | 996 | int early_data; /*!< Early data indication: |
| 997 | * 0 -- MBEDTLS_SSL_EARLY_DATA_DISABLED (for no early data), and |
| 998 | * 1 -- MBEDTLS_SSL_EARLY_DATA_ENABLED (for use early data) |
| 999 | */ |
| 1000 | #endif /* MBEDTLS_SSL_EARLY_DATA */ |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1001 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1002 | |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 1003 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
| 1004 | /** Asynchronous operation context. This field is meant for use by the |
| 1005 | * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start, |
| 1006 | * mbedtls_ssl_config::f_async_decrypt_start, |
| 1007 | * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel). |
| 1008 | * The library does not use it internally. */ |
| 1009 | void *user_async_ctx; |
| 1010 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 1011 | |
| 1012 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
| 1013 | const unsigned char *sni_name; /*!< raw SNI */ |
| 1014 | size_t sni_name_len; /*!< raw SNI len */ |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 1015 | #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) |
| 1016 | const mbedtls_x509_crt *dn_hints; /*!< acceptable client cert issuers */ |
| 1017 | #endif |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 1018 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1019 | }; |
| 1020 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 1021 | typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer; |
| 1022 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1023 | /* |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1024 | * Representation of decryption/encryption transformations on records |
| 1025 | * |
| 1026 | * There are the following general types of record transformations: |
TRodziewicz | 2abf03c | 2021-06-25 14:40:09 +0200 | [diff] [blame] | 1027 | * - Stream transformations (TLS versions == 1.2 only) |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1028 | * Transformation adding a MAC and applying a stream-cipher |
| 1029 | * to the authenticated message. |
TRodziewicz | 2abf03c | 2021-06-25 14:40:09 +0200 | [diff] [blame] | 1030 | * - CBC block cipher transformations ([D]TLS versions == 1.2 only) |
| 1031 | * For TLS 1.2, no IV is generated at key extraction time, but every |
| 1032 | * encrypted record is explicitly prefixed by the IV with which it was |
| 1033 | * encrypted. |
| 1034 | * - AEAD transformations ([D]TLS versions == 1.2 only) |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1035 | * These come in two fundamentally different versions, the first one |
| 1036 | * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second |
| 1037 | * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3. |
| 1038 | * In the first transformation, the IV to be used for a record is obtained |
| 1039 | * as the concatenation of an explicit, static 4-byte IV and the 8-byte |
| 1040 | * record sequence number, and explicitly prepending this sequence number |
| 1041 | * to the encrypted record. In contrast, in the second transformation |
| 1042 | * the IV is obtained by XOR'ing a static IV obtained at key extraction |
| 1043 | * time with the 8-byte record sequence number, without prepending the |
| 1044 | * latter to the encrypted record. |
| 1045 | * |
Hanno Becker | 7d343ec | 2020-05-04 12:29:05 +0100 | [diff] [blame] | 1046 | * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext |
| 1047 | * which allows to add flexible length padding and to hide a record's true |
| 1048 | * content type. |
| 1049 | * |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1050 | * In addition to type and version, the following parameters are relevant: |
| 1051 | * - The symmetric cipher algorithm to be used. |
| 1052 | * - The (static) encryption/decryption keys for the cipher. |
| 1053 | * - For stream/CBC, the type of message digest to be used. |
| 1054 | * - For stream/CBC, (static) encryption/decryption keys for the digest. |
Hanno Becker | 0db7e0c | 2018-10-18 15:39:53 +0100 | [diff] [blame] | 1055 | * - For AEAD transformations, the size (potentially 0) of an explicit, |
| 1056 | * random initialization vector placed in encrypted records. |
TRodziewicz | 299510e | 2021-07-09 16:55:11 +0200 | [diff] [blame] | 1057 | * - For some transformations (currently AEAD) an implicit IV. It is static |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1058 | * and (if present) is combined with the explicit IV in a transformation- |
TRodziewicz | 299510e | 2021-07-09 16:55:11 +0200 | [diff] [blame] | 1059 | * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3). |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1060 | * - For stream/CBC, a flag determining the order of encryption and MAC. |
| 1061 | * - The details of the transformation depend on the SSL/TLS version. |
| 1062 | * - The length of the authentication tag. |
| 1063 | * |
| 1064 | * The struct below refines this abstract view as follows: |
| 1065 | * - The cipher underlying the transformation is managed in |
| 1066 | * cipher contexts cipher_ctx_{enc/dec}, which must have the |
| 1067 | * same cipher type. The mode of these cipher contexts determines |
| 1068 | * the type of the transformation in the sense above: e.g., if |
| 1069 | * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM |
| 1070 | * then the transformation has type CBC resp. AEAD. |
| 1071 | * - The cipher keys are never stored explicitly but |
| 1072 | * are maintained within cipher_ctx_{enc/dec}. |
| 1073 | * - For stream/CBC transformations, the message digest contexts |
| 1074 | * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts |
| 1075 | * are unused for AEAD transformations. |
TRodziewicz | 2abf03c | 2021-06-25 14:40:09 +0200 | [diff] [blame] | 1076 | * - For stream/CBC transformations, the MAC keys are not stored explicitly |
| 1077 | * but maintained within md_ctx_{enc/dec}. |
| 1078 | * - The mac_enc and mac_dec fields are unused for EAD transformations. |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1079 | * - For transformations using an implicit IV maintained within |
| 1080 | * the transformation context, its contents are stored within |
| 1081 | * iv_{enc/dec}. |
| 1082 | * - The value of ivlen indicates the length of the IV. |
| 1083 | * This is redundant in case of stream/CBC transformations |
| 1084 | * which always use 0 resp. the cipher's block length as the |
| 1085 | * IV length, but is needed for AEAD ciphers and may be |
| 1086 | * different from the underlying cipher's block length |
| 1087 | * in this case. |
| 1088 | * - The field fixed_ivlen is nonzero for AEAD transformations only |
| 1089 | * and indicates the length of the static part of the IV which is |
| 1090 | * constant throughout the communication, and which is stored in |
| 1091 | * the first fixed_ivlen bytes of the iv_{enc/dec} arrays. |
Glenn Strauss | 07c6416 | 2022-03-14 12:34:51 -0400 | [diff] [blame] | 1092 | * - tls_version denotes the 2-byte TLS version |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 1093 | * - For stream/CBC transformations, maclen denotes the length of the |
| 1094 | * authentication tag, while taglen is unused and 0. |
| 1095 | * - For AEAD transformations, taglen denotes the length of the |
| 1096 | * authentication tag, while maclen is unused and 0. |
| 1097 | * - For CBC transformations, encrypt_then_mac determines the |
| 1098 | * order of encryption and authentication. This field is unused |
| 1099 | * in other transformations. |
| 1100 | * |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1101 | */ |
| 1102 | struct mbedtls_ssl_transform |
| 1103 | { |
| 1104 | /* |
| 1105 | * Session specific crypto layer |
| 1106 | */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1107 | size_t minlen; /*!< min. ciphertext length */ |
| 1108 | size_t ivlen; /*!< IV length */ |
| 1109 | size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */ |
Hanno Becker | e694c3e | 2017-12-27 21:34:08 +0000 | [diff] [blame] | 1110 | size_t maclen; /*!< MAC(CBC) len */ |
| 1111 | size_t taglen; /*!< TAG(AEAD) len */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1112 | |
| 1113 | unsigned char iv_enc[16]; /*!< IV (encryption) */ |
| 1114 | unsigned char iv_dec[16]; /*!< IV (decryption) */ |
| 1115 | |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 1116 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) |
Hanno Becker | d56ed24 | 2018-01-03 15:32:51 +0000 | [diff] [blame] | 1117 | |
Neil Armstrong | 39b8e7d | 2022-02-23 09:24:45 +0100 | [diff] [blame] | 1118 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 1119 | mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */ |
| 1120 | mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */ |
| 1121 | psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */ |
Neil Armstrong | cf8841a | 2022-02-24 11:17:45 +0100 | [diff] [blame] | 1122 | #else |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1123 | mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */ |
| 1124 | mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */ |
Neil Armstrong | cf8841a | 2022-02-24 11:17:45 +0100 | [diff] [blame] | 1125 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1126 | |
Hanno Becker | 9eddaeb | 2017-12-27 21:37:21 +0000 | [diff] [blame] | 1127 | #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
| 1128 | int encrypt_then_mac; /*!< flag for EtM activation */ |
| 1129 | #endif |
| 1130 | |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 1131 | #endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */ |
Hanno Becker | d56ed24 | 2018-01-03 15:32:51 +0000 | [diff] [blame] | 1132 | |
Glenn Strauss | 07c6416 | 2022-03-14 12:34:51 -0400 | [diff] [blame] | 1133 | mbedtls_ssl_protocol_version tls_version; |
Hanno Becker | 9eddaeb | 2017-12-27 21:37:21 +0000 | [diff] [blame] | 1134 | |
Przemyslaw Stekiel | 44187d7 | 2022-01-11 08:25:29 +0100 | [diff] [blame] | 1135 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 1136 | mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */ |
| 1137 | mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */ |
| 1138 | psa_algorithm_t psa_alg; /*!< psa algorithm */ |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 1139 | #else |
| 1140 | mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */ |
| 1141 | mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */ |
Przemyslaw Stekiel | 44187d7 | 2022-01-11 08:25:29 +0100 | [diff] [blame] | 1142 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 1143 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1144 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 1327fa7 | 2019-04-25 15:54:02 +0100 | [diff] [blame] | 1145 | uint8_t in_cid_len; |
| 1146 | uint8_t out_cid_len; |
| 1147 | unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; |
| 1148 | unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1149 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 1327fa7 | 2019-04-25 15:54:02 +0100 | [diff] [blame] | 1150 | |
Manuel Pégourié-Gonnard | 96fb0ee | 2019-07-09 12:54:17 +0200 | [diff] [blame] | 1151 | #if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION) |
| 1152 | /* We need the Hello random bytes in order to re-derive keys from the |
Hanno Becker | bd25755 | 2021-03-22 06:59:27 +0000 | [diff] [blame] | 1153 | * Master Secret and other session info, |
| 1154 | * see ssl_tls12_populate_transform() */ |
Jerry Yu | e6d7e5c | 2021-10-26 10:44:32 +0800 | [diff] [blame] | 1155 | unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN + |
| 1156 | MBEDTLS_CLIENT_HELLO_RANDOM_LEN]; |
| 1157 | /*!< ServerHello.random+ClientHello.random */ |
Manuel Pégourié-Gonnard | 96fb0ee | 2019-07-09 12:54:17 +0200 | [diff] [blame] | 1158 | #endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1159 | }; |
| 1160 | |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1161 | /* |
Manuel Pégourié-Gonnard | 1aaf669 | 2019-07-10 14:14:05 +0200 | [diff] [blame] | 1162 | * Return 1 if the transform uses an AEAD cipher, 0 otherwise. |
| 1163 | * Equivalently, return 0 if a separate MAC is used, 1 otherwise. |
| 1164 | */ |
| 1165 | static inline int mbedtls_ssl_transform_uses_aead( |
| 1166 | const mbedtls_ssl_transform *transform ) |
| 1167 | { |
Hanno Becker | fd86ca8 | 2020-11-30 08:54:23 +0000 | [diff] [blame] | 1168 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) |
Manuel Pégourié-Gonnard | 1aaf669 | 2019-07-10 14:14:05 +0200 | [diff] [blame] | 1169 | return( transform->maclen == 0 && transform->taglen != 0 ); |
| 1170 | #else |
| 1171 | (void) transform; |
| 1172 | return( 1 ); |
| 1173 | #endif |
| 1174 | } |
| 1175 | |
| 1176 | /* |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1177 | * Internal representation of record frames |
| 1178 | * |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1179 | * Instances come in two flavors: |
| 1180 | * (1) Encrypted |
| 1181 | * These always have data_offset = 0 |
| 1182 | * (2) Unencrypted |
Hanno Becker | cd430bc | 2019-04-04 16:29:48 +0100 | [diff] [blame] | 1183 | * These have data_offset set to the amount of |
| 1184 | * pre-expansion during record protection. Concretely, |
| 1185 | * this is the length of the fixed part of the explicit IV |
| 1186 | * used for encryption, or 0 if no explicit IV is used |
TRodziewicz | 2abf03c | 2021-06-25 14:40:09 +0200 | [diff] [blame] | 1187 | * (e.g. for stream ciphers). |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1188 | * |
| 1189 | * The reason for the data_offset in the unencrypted case |
| 1190 | * is to allow for in-place conversion of an unencrypted to |
| 1191 | * an encrypted record. If the offset wasn't included, the |
| 1192 | * encrypted content would need to be shifted afterwards to |
| 1193 | * make space for the fixed IV. |
| 1194 | * |
| 1195 | */ |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 1196 | #if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX |
Hanno Becker | 75f080f | 2019-04-30 15:01:51 +0100 | [diff] [blame] | 1197 | #define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 1198 | #else |
Hanno Becker | 75f080f | 2019-04-30 15:01:51 +0100 | [diff] [blame] | 1199 | #define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 1200 | #endif |
| 1201 | |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1202 | typedef struct |
| 1203 | { |
Jerry Yu | ae0b2e2 | 2021-10-08 15:21:19 +0800 | [diff] [blame] | 1204 | uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number. |
| 1205 | * In DTLS: The 2-byte epoch followed by |
| 1206 | * the 6-byte sequence number. |
| 1207 | * This is stored as a raw big endian byte array |
| 1208 | * as opposed to a uint64_t because we rarely |
| 1209 | * need to perform arithmetic on this, but do |
| 1210 | * need it as a Byte array for the purpose of |
| 1211 | * MAC computations. */ |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 1212 | uint8_t type; /* The record content type. */ |
| 1213 | uint8_t ver[2]; /* SSL/TLS version as present on the wire. |
| 1214 | * Convert to internal presentation of versions |
| 1215 | * using mbedtls_ssl_read_version() and |
| 1216 | * mbedtls_ssl_write_version(). |
| 1217 | * Keep wire-format for MAC computations. */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1218 | |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 1219 | unsigned char *buf; /* Memory buffer enclosing the record content */ |
| 1220 | size_t buf_len; /* Buffer length */ |
| 1221 | size_t data_offset; /* Offset of record content */ |
| 1222 | size_t data_len; /* Length of record content */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1223 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1224 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 1225 | uint8_t cid_len; /* Length of the CID (0 if not present) */ |
| 1226 | unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1227 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 1228 | } mbedtls_record; |
| 1229 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1230 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 1231 | /* |
| 1232 | * List of certificate + private key pairs |
| 1233 | */ |
| 1234 | struct mbedtls_ssl_key_cert |
| 1235 | { |
| 1236 | mbedtls_x509_crt *cert; /*!< cert */ |
| 1237 | mbedtls_pk_context *key; /*!< private key */ |
| 1238 | mbedtls_ssl_key_cert *next; /*!< next key/cert pair */ |
| 1239 | }; |
| 1240 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 1241 | |
| 1242 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1243 | /* |
| 1244 | * List of handshake messages kept around for resending |
| 1245 | */ |
| 1246 | struct mbedtls_ssl_flight_item |
| 1247 | { |
| 1248 | unsigned char *p; /*!< message, including handshake headers */ |
| 1249 | size_t len; /*!< length of p */ |
| 1250 | unsigned char type; /*!< type of the message: handshake or CCS */ |
| 1251 | mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */ |
| 1252 | }; |
| 1253 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 1254 | |
Ronald Cron | 4079abc | 2022-02-20 10:35:26 +0100 | [diff] [blame] | 1255 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 1256 | /** |
| 1257 | * \brief Given an SSL context and its associated configuration, write the TLS |
| 1258 | * 1.2 specific extensions of the ClientHello message. |
| 1259 | * |
| 1260 | * \param[in] ssl SSL context |
| 1261 | * \param[in] buf Base address of the buffer where to write the extensions |
| 1262 | * \param[in] end End address of the buffer where to write the extensions |
| 1263 | * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve |
| 1264 | * (<> 0) or not ( 0 ). |
| 1265 | * \param[out] out_len Length of the data written into the buffer \p buf |
| 1266 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1267 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 4079abc | 2022-02-20 10:35:26 +0100 | [diff] [blame] | 1268 | int mbedtls_ssl_tls12_write_client_hello_exts( mbedtls_ssl_context *ssl, |
| 1269 | unsigned char *buf, |
| 1270 | const unsigned char *end, |
| 1271 | int uses_ec, |
| 1272 | size_t *out_len ); |
| 1273 | #endif |
| 1274 | |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 1275 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 1276 | defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 1277 | |
Gabor Mezei | a3d016c | 2022-05-10 12:44:09 +0200 | [diff] [blame] | 1278 | /** |
| 1279 | * \brief Find the preferred hash for a given signature algorithm. |
| 1280 | * |
| 1281 | * \param[in] ssl SSL context |
| 1282 | * \param[in] sig_alg A signature algorithm identifier as defined in the |
| 1283 | * TLS 1.2 SignatureAlgorithm enumeration. |
| 1284 | * |
| 1285 | * \return The preferred hash algorithm for \p sig_alg. It is a hash algorithm |
| 1286 | * identifier as defined in the TLS 1.2 HashAlgorithm enumeration. |
| 1287 | */ |
| 1288 | unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg( |
| 1289 | mbedtls_ssl_context *ssl, |
| 1290 | unsigned int sig_alg ); |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 1291 | |
Gabor Mezei | 078e803 | 2022-04-27 21:17:56 +0200 | [diff] [blame] | 1292 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 && |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 1293 | MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1294 | |
| 1295 | /** |
| 1296 | * \brief Free referenced items in an SSL transform context and clear |
| 1297 | * memory |
| 1298 | * |
| 1299 | * \param transform SSL transform context |
| 1300 | */ |
| 1301 | void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform ); |
| 1302 | |
| 1303 | /** |
| 1304 | * \brief Free referenced items in an SSL handshake context and clear |
| 1305 | * memory |
| 1306 | * |
Gilles Peskine | 9b562d5 | 2018-04-25 20:32:43 +0200 | [diff] [blame] | 1307 | * \param ssl SSL context |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1308 | */ |
Gilles Peskine | 9b562d5 | 2018-04-25 20:32:43 +0200 | [diff] [blame] | 1309 | void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1310 | |
Jerry Yu | c7875b5 | 2021-09-05 21:05:50 +0800 | [diff] [blame] | 1311 | /* set inbound transform of ssl context */ |
| 1312 | void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl, |
| 1313 | mbedtls_ssl_transform *transform ); |
| 1314 | |
| 1315 | /* set outbound transform of ssl context */ |
| 1316 | void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl, |
| 1317 | mbedtls_ssl_transform *transform ); |
| 1318 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1319 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1320 | int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1321 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1322 | int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl ); |
| 1323 | void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl ); |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1324 | static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl, |
| 1325 | mbedtls_ssl_states state ) |
| 1326 | { |
| 1327 | ssl->state = ( int ) state; |
| 1328 | } |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1329 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1330 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1331 | int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl ); |
| 1332 | |
| 1333 | void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl ); |
Jerry Yu | bef175d | 2022-01-28 10:52:05 +0800 | [diff] [blame] | 1334 | |
| 1335 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1336 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1337 | int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl ); |
Jerry Yu | bef175d | 2022-01-28 10:52:05 +0800 | [diff] [blame] | 1338 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1339 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1340 | MBEDTLS_CHECK_RETURN_CRITICAL |
Simon Butcher | 9900014 | 2016-10-13 17:21:01 +0100 | [diff] [blame] | 1341 | int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1342 | MBEDTLS_CHECK_RETURN_CRITICAL |
Simon Butcher | 9900014 | 2016-10-13 17:21:01 +0100 | [diff] [blame] | 1343 | int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl ); |
| 1344 | void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl ); |
| 1345 | |
Hanno Becker | 4a810fb | 2017-05-24 16:27:30 +0100 | [diff] [blame] | 1346 | /** |
| 1347 | * \brief Update record layer |
| 1348 | * |
| 1349 | * This function roughly separates the implementation |
| 1350 | * of the logic of (D)TLS from the implementation |
| 1351 | * of the secure transport. |
| 1352 | * |
Hanno Becker | 3a0aad1 | 2018-08-20 09:44:02 +0100 | [diff] [blame] | 1353 | * \param ssl The SSL context to use. |
| 1354 | * \param update_hs_digest This indicates if the handshake digest |
| 1355 | * should be automatically updated in case |
| 1356 | * a handshake message is found. |
Hanno Becker | 4a810fb | 2017-05-24 16:27:30 +0100 | [diff] [blame] | 1357 | * |
| 1358 | * \return 0 or non-zero error code. |
| 1359 | * |
| 1360 | * \note A clarification on what is called 'record layer' here |
| 1361 | * is in order, as many sensible definitions are possible: |
| 1362 | * |
| 1363 | * The record layer takes as input an untrusted underlying |
| 1364 | * transport (stream or datagram) and transforms it into |
| 1365 | * a serially multiplexed, secure transport, which |
| 1366 | * conceptually provides the following: |
| 1367 | * |
| 1368 | * (1) Three datagram based, content-agnostic transports |
| 1369 | * for handshake, alert and CCS messages. |
| 1370 | * (2) One stream- or datagram-based transport |
| 1371 | * for application data. |
| 1372 | * (3) Functionality for changing the underlying transform |
| 1373 | * securing the contents. |
| 1374 | * |
| 1375 | * The interface to this functionality is given as follows: |
| 1376 | * |
| 1377 | * a Updating |
| 1378 | * [Currently implemented by mbedtls_ssl_read_record] |
| 1379 | * |
| 1380 | * Check if and on which of the four 'ports' data is pending: |
| 1381 | * Nothing, a controlling datagram of type (1), or application |
| 1382 | * data (2). In any case data is present, internal buffers |
| 1383 | * provide access to the data for the user to process it. |
| 1384 | * Consumption of type (1) datagrams is done automatically |
| 1385 | * on the next update, invalidating that the internal buffers |
| 1386 | * for previous datagrams, while consumption of application |
| 1387 | * data (2) is user-controlled. |
| 1388 | * |
| 1389 | * b Reading of application data |
| 1390 | * [Currently manual adaption of ssl->in_offt pointer] |
| 1391 | * |
| 1392 | * As mentioned in the last paragraph, consumption of data |
| 1393 | * is different from the automatic consumption of control |
| 1394 | * datagrams (1) because application data is treated as a stream. |
| 1395 | * |
| 1396 | * c Tracking availability of application data |
| 1397 | * [Currently manually through decreasing ssl->in_msglen] |
| 1398 | * |
| 1399 | * For efficiency and to retain datagram semantics for |
| 1400 | * application data in case of DTLS, the record layer |
| 1401 | * provides functionality for checking how much application |
| 1402 | * data is still available in the internal buffer. |
| 1403 | * |
| 1404 | * d Changing the transformation securing the communication. |
| 1405 | * |
| 1406 | * Given an opaque implementation of the record layer in the |
| 1407 | * above sense, it should be possible to implement the logic |
| 1408 | * of (D)TLS on top of it without the need to know anything |
| 1409 | * about the record layer's internals. This is done e.g. |
| 1410 | * in all the handshake handling functions, and in the |
| 1411 | * application data reading function mbedtls_ssl_read. |
| 1412 | * |
| 1413 | * \note The above tries to give a conceptual picture of the |
| 1414 | * record layer, but the current implementation deviates |
| 1415 | * from it in some places. For example, our implementation of |
| 1416 | * the update functionality through mbedtls_ssl_read_record |
| 1417 | * discards datagrams depending on the current state, which |
| 1418 | * wouldn't fall under the record layer's responsibility |
| 1419 | * following the above definition. |
| 1420 | * |
| 1421 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1422 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 3a0aad1 | 2018-08-20 09:44:02 +0100 | [diff] [blame] | 1423 | int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl, |
| 1424 | unsigned update_hs_digest ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1425 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1426 | int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want ); |
| 1427 | |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1428 | /* |
| 1429 | * Write handshake message header |
| 1430 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1431 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1432 | int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type, |
| 1433 | unsigned char **buf, size_t *buf_len ); |
| 1434 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1435 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | f3cce8b | 2021-08-07 14:29:49 +0100 | [diff] [blame] | 1436 | int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl, |
Ronald Cron | 66dbf91 | 2022-02-02 15:33:46 +0100 | [diff] [blame] | 1437 | int update_checksum, |
Ronald Cron | 00d012f2 | 2022-03-08 15:57:12 +0100 | [diff] [blame] | 1438 | int force_flush ); |
Hanno Becker | f3cce8b | 2021-08-07 14:29:49 +0100 | [diff] [blame] | 1439 | static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl ) |
| 1440 | { |
Ronald Cron | 66dbf91 | 2022-02-02 15:33:46 +0100 | [diff] [blame] | 1441 | return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */, 1 /* force flush */ ) ); |
Hanno Becker | f3cce8b | 2021-08-07 14:29:49 +0100 | [diff] [blame] | 1442 | } |
| 1443 | |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1444 | /* |
| 1445 | * Write handshake message tail |
| 1446 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1447 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1448 | int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl, |
| 1449 | size_t buf_len, size_t msg_len ); |
| 1450 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1451 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 00d012f2 | 2022-03-08 15:57:12 +0100 | [diff] [blame] | 1452 | int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1453 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1454 | int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl ); |
| 1455 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1456 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1457 | int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1458 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1459 | int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl ); |
| 1460 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1461 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1462 | int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1463 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1464 | int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl ); |
| 1465 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1466 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1467 | int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1468 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1469 | int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl ); |
| 1470 | |
| 1471 | void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl, |
| 1472 | const mbedtls_ssl_ciphersuite_t *ciphersuite_info ); |
| 1473 | |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1474 | /* |
| 1475 | * Update checksum of handshake messages. |
| 1476 | */ |
| 1477 | void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl, |
| 1478 | unsigned hs_type, |
| 1479 | unsigned char const *msg, |
| 1480 | size_t msg_len ); |
| 1481 | |
XiaokangQian | 8698195 | 2022-07-19 09:51:50 +0000 | [diff] [blame] | 1482 | void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl, |
| 1483 | unsigned hs_type, |
| 1484 | size_t total_hs_len ); |
| 1485 | |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 1486 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) |
Neil Armstrong | 80f6f32 | 2022-05-03 17:56:38 +0200 | [diff] [blame] | 1487 | #if !defined(MBEDTLS_USE_PSA_CRYPTO) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1488 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 8f6d39a | 2022-03-10 18:56:50 +0100 | [diff] [blame] | 1489 | int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, |
| 1490 | mbedtls_key_exchange_type_t key_ex ); |
Neil Armstrong | 80f6f32 | 2022-05-03 17:56:38 +0200 | [diff] [blame] | 1491 | #endif /* !MBEDTLS_USE_PSA_CRYPTO */ |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1492 | #endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */ |
Ronald Cron | d29e13e | 2022-10-19 10:33:48 +0200 | [diff] [blame] | 1493 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1494 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) |
Ronald Cron | d29e13e | 2022-10-19 10:33:48 +0200 | [diff] [blame] | 1495 | #if defined(MBEDTLS_SSL_CLI_C) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1496 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | d491c2d | 2022-02-19 18:30:46 +0100 | [diff] [blame] | 1497 | int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf ); |
| 1498 | #endif |
Neil Armstrong | 044a32c | 2022-05-03 10:35:56 +0200 | [diff] [blame] | 1499 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 1500 | /** |
| 1501 | * Get the first defined opaque PSK by order of precedence: |
| 1502 | * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK |
| 1503 | * callback |
| 1504 | * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque() |
| 1505 | * Return an opaque PSK |
| 1506 | */ |
| 1507 | static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk( |
| 1508 | const mbedtls_ssl_context *ssl ) |
| 1509 | { |
| 1510 | if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) ) |
| 1511 | return( ssl->handshake->psk_opaque ); |
| 1512 | |
| 1513 | if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) ) |
| 1514 | return( ssl->conf->psk_opaque ); |
| 1515 | |
| 1516 | return( MBEDTLS_SVC_KEY_ID_INIT ); |
| 1517 | } |
| 1518 | #else |
Guilhem Bryant | 8a69ddd | 2020-03-27 11:13:39 +0000 | [diff] [blame] | 1519 | /** |
Guilhem Bryant | d511ac3 | 2020-03-25 17:06:37 +0000 | [diff] [blame] | 1520 | * Get the first defined PSK by order of precedence: |
| 1521 | * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback |
| 1522 | * 2. static PSK configured by \c mbedtls_ssl_conf_psk() |
| 1523 | * Return a code and update the pair (PSK, PSK length) passed to this function |
| 1524 | */ |
| 1525 | static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl, |
| 1526 | const unsigned char **psk, size_t *psk_len ) |
| 1527 | { |
| 1528 | if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 ) |
| 1529 | { |
| 1530 | *psk = ssl->handshake->psk; |
| 1531 | *psk_len = ssl->handshake->psk_len; |
| 1532 | } |
| 1533 | |
| 1534 | else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 ) |
| 1535 | { |
| 1536 | *psk = ssl->conf->psk; |
| 1537 | *psk_len = ssl->conf->psk_len; |
| 1538 | } |
| 1539 | |
| 1540 | else |
| 1541 | { |
Guilhem Bryant | b5f04e4 | 2020-04-01 11:23:58 +0100 | [diff] [blame] | 1542 | *psk = NULL; |
| 1543 | *psk_len = 0; |
Guilhem Bryant | d511ac3 | 2020-03-25 17:06:37 +0000 | [diff] [blame] | 1544 | return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED ); |
| 1545 | } |
| 1546 | |
| 1547 | return( 0 ); |
| 1548 | } |
Guilhem Bryant | d511ac3 | 2020-03-25 17:06:37 +0000 | [diff] [blame] | 1549 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 1550 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1551 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */ |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1552 | |
| 1553 | #if defined(MBEDTLS_PK_C) |
| 1554 | unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk ); |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 1555 | unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1556 | mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig ); |
| 1557 | #endif |
| 1558 | |
| 1559 | mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash ); |
Manuel Pégourié-Gonnard | 7bfc122 | 2015-06-17 14:34:48 +0200 | [diff] [blame] | 1560 | unsigned char mbedtls_ssl_hash_from_md_alg( int md ); |
Ronald Cron | 4dcbca9 | 2022-03-07 10:21:40 +0100 | [diff] [blame] | 1561 | |
| 1562 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1563 | MBEDTLS_CHECK_RETURN_CRITICAL |
Simon Butcher | 9900014 | 2016-10-13 17:21:01 +0100 | [diff] [blame] | 1564 | int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md ); |
Ronald Cron | 4dcbca9 | 2022-03-07 10:21:40 +0100 | [diff] [blame] | 1565 | #endif |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1566 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1567 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 0d63b84 | 2022-01-18 13:10:56 +0100 | [diff] [blame] | 1568 | int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id ); |
Manuel Pégourié-Gonnard | b541da6 | 2015-06-17 11:43:30 +0200 | [diff] [blame] | 1569 | #if defined(MBEDTLS_ECP_C) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1570 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 9d412d8 | 2015-06-17 12:10:46 +0200 | [diff] [blame] | 1571 | int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1572 | #endif |
| 1573 | |
Ron Eldor | 089c9fe | 2018-12-06 17:12:49 +0200 | [diff] [blame] | 1574 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1575 | static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value |
| 1576 | ( const uint16_t srtp_profile_value ) |
Ron Eldor | 089c9fe | 2018-12-06 17:12:49 +0200 | [diff] [blame] | 1577 | { |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1578 | switch( srtp_profile_value ) |
Ron Eldor | 089c9fe | 2018-12-06 17:12:49 +0200 | [diff] [blame] | 1579 | { |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 1580 | case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80: |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 1581 | case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32: |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 1582 | case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80: |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 1583 | case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32: |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1584 | return srtp_profile_value; |
Ron Eldor | 089c9fe | 2018-12-06 17:12:49 +0200 | [diff] [blame] | 1585 | default: break; |
| 1586 | } |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1587 | return( MBEDTLS_TLS_SRTP_UNSET ); |
Ron Eldor | 089c9fe | 2018-12-06 17:12:49 +0200 | [diff] [blame] | 1588 | } |
| 1589 | #endif |
| 1590 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1591 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 1592 | static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl ) |
| 1593 | { |
| 1594 | mbedtls_ssl_key_cert *key_cert; |
| 1595 | |
| 1596 | if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL ) |
| 1597 | key_cert = ssl->handshake->key_cert; |
| 1598 | else |
| 1599 | key_cert = ssl->conf->key_cert; |
| 1600 | |
| 1601 | return( key_cert == NULL ? NULL : key_cert->key ); |
| 1602 | } |
| 1603 | |
| 1604 | static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl ) |
| 1605 | { |
| 1606 | mbedtls_ssl_key_cert *key_cert; |
| 1607 | |
| 1608 | if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL ) |
| 1609 | key_cert = ssl->handshake->key_cert; |
| 1610 | else |
| 1611 | key_cert = ssl->conf->key_cert; |
| 1612 | |
| 1613 | return( key_cert == NULL ? NULL : key_cert->cert ); |
| 1614 | } |
| 1615 | |
| 1616 | /* |
| 1617 | * Check usage of a certificate wrt extensions: |
| 1618 | * keyUsage, extendedKeyUsage (later), and nSCertType (later). |
| 1619 | * |
| 1620 | * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we |
| 1621 | * check a cert we received from them)! |
| 1622 | * |
| 1623 | * Return 0 if everything is OK, -1 if not. |
| 1624 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1625 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1626 | int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert, |
| 1627 | const mbedtls_ssl_ciphersuite_t *ciphersuite, |
| 1628 | int cert_endpoint, |
| 1629 | uint32_t *flags ); |
| 1630 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 1631 | |
Glenn Strauss | e3af4cb | 2022-03-15 03:23:42 -0400 | [diff] [blame] | 1632 | void mbedtls_ssl_write_version( unsigned char version[2], int transport, |
| 1633 | mbedtls_ssl_protocol_version tls_version ); |
| 1634 | uint16_t mbedtls_ssl_read_version( const unsigned char version[2], |
| 1635 | int transport ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1636 | |
Hanno Becker | 5903de4 | 2019-05-03 14:46:38 +0100 | [diff] [blame] | 1637 | static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl ) |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1638 | { |
Hanno Becker | 47be768 | 2019-07-12 09:55:46 +0100 | [diff] [blame] | 1639 | #if !defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1640 | ((void) ssl); |
| 1641 | #endif |
| 1642 | |
| 1643 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1644 | if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) |
| 1645 | { |
| 1646 | return( 13 ); |
| 1647 | } |
| 1648 | else |
| 1649 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 1650 | { |
| 1651 | return( 5 ); |
| 1652 | } |
Hanno Becker | 5903de4 | 2019-05-03 14:46:38 +0100 | [diff] [blame] | 1653 | } |
| 1654 | |
| 1655 | static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl ) |
| 1656 | { |
Hanno Becker | 3b154c1 | 2019-05-03 15:05:27 +0100 | [diff] [blame] | 1657 | return( (size_t) ( ssl->out_iv - ssl->out_hdr ) ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1658 | } |
| 1659 | |
| 1660 | static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl ) |
| 1661 | { |
| 1662 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1663 | if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) |
| 1664 | return( 12 ); |
| 1665 | #else |
| 1666 | ((void) ssl); |
| 1667 | #endif |
| 1668 | return( 4 ); |
| 1669 | } |
| 1670 | |
| 1671 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1672 | void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl ); |
| 1673 | void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1674 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1675 | int mbedtls_ssl_resend( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1676 | MBEDTLS_CHECK_RETURN_CRITICAL |
Manuel Pégourié-Gonnard | 87a346f | 2017-09-13 12:45:21 +0200 | [diff] [blame] | 1677 | int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1678 | #endif |
| 1679 | |
| 1680 | /* Visible for testing purposes only */ |
| 1681 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1682 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 0183d69 | 2019-07-12 08:50:37 +0100 | [diff] [blame] | 1683 | int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1684 | void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl ); |
| 1685 | #endif |
| 1686 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1687 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 52055ae | 2019-02-06 14:30:46 +0000 | [diff] [blame] | 1688 | int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst, |
| 1689 | const mbedtls_ssl_session *src ); |
| 1690 | |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1691 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Andrzej Kurek | 814feff | 2019-01-14 04:35:19 -0500 | [diff] [blame] | 1692 | /* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1693 | MBEDTLS_CHECK_RETURN_CRITICAL |
Andres Amaya Garcia | 46f5a3e | 2017-07-20 16:17:51 +0100 | [diff] [blame] | 1694 | int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl, |
Gilles Peskine | ca1d742 | 2018-04-24 11:53:22 +0200 | [diff] [blame] | 1695 | unsigned char *hash, size_t *hashlen, |
| 1696 | unsigned char *data, size_t data_len, |
| 1697 | mbedtls_md_type_t md_alg ); |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1698 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
Andres Amaya Garcia | 46f5a3e | 2017-07-20 16:17:51 +0100 | [diff] [blame] | 1699 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1700 | #ifdef __cplusplus |
| 1701 | } |
| 1702 | #endif |
| 1703 | |
Hanno Becker | a18d132 | 2018-01-03 14:27:32 +0000 | [diff] [blame] | 1704 | void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1705 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | a18d132 | 2018-01-03 14:27:32 +0000 | [diff] [blame] | 1706 | int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl, |
| 1707 | mbedtls_ssl_transform *transform, |
| 1708 | mbedtls_record *rec, |
| 1709 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1710 | void *p_rng ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1711 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 605949f | 2019-07-12 08:23:59 +0100 | [diff] [blame] | 1712 | int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl, |
Hanno Becker | a18d132 | 2018-01-03 14:27:32 +0000 | [diff] [blame] | 1713 | mbedtls_ssl_transform *transform, |
| 1714 | mbedtls_record *rec ); |
| 1715 | |
Hanno Becker | dd77229 | 2020-02-05 10:38:31 +0000 | [diff] [blame] | 1716 | /* Length of the "epoch" field in the record header */ |
| 1717 | static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl ) |
| 1718 | { |
| 1719 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 1720 | if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) |
| 1721 | return( 2 ); |
| 1722 | #else |
| 1723 | ((void) ssl); |
| 1724 | #endif |
| 1725 | return( 0 ); |
| 1726 | } |
| 1727 | |
Hanno Becker | 08f0913 | 2020-02-11 15:40:07 +0000 | [diff] [blame] | 1728 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1729 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 786300f | 2020-02-05 10:46:40 +0000 | [diff] [blame] | 1730 | int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl ); |
Hanno Becker | 08f0913 | 2020-02-11 15:40:07 +0000 | [diff] [blame] | 1731 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Hanno Becker | 0f57a65 | 2020-02-05 10:37:26 +0000 | [diff] [blame] | 1732 | |
| 1733 | void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1734 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 7876d12 | 2020-02-05 10:39:31 +0000 | [diff] [blame] | 1735 | int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl ); |
| 1736 | |
Hanno Becker | 3e6f8ab | 2020-02-05 10:40:57 +0000 | [diff] [blame] | 1737 | void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl ); |
| 1738 | void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl, |
| 1739 | mbedtls_ssl_transform *transform ); |
| 1740 | void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl ); |
| 1741 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1742 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 43aefe2 | 2020-02-05 10:44:56 +0000 | [diff] [blame] | 1743 | int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial ); |
XiaokangQian | 78b1fa7 | 2022-01-19 06:56:30 +0000 | [diff] [blame] | 1744 | void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl, |
| 1745 | int partial ); |
Hanno Becker | 43aefe2 | 2020-02-05 10:44:56 +0000 | [diff] [blame] | 1746 | |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1747 | /* |
Jerry Yu | 394ece6 | 2021-09-14 22:17:21 +0800 | [diff] [blame] | 1748 | * Send pending alert |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1749 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1750 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1751 | int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl ); |
| 1752 | |
Jerry Yu | 394ece6 | 2021-09-14 22:17:21 +0800 | [diff] [blame] | 1753 | /* |
| 1754 | * Set pending fatal alert flag. |
| 1755 | */ |
| 1756 | void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl, |
| 1757 | unsigned char alert_type, |
| 1758 | int alert_reason ); |
| 1759 | |
| 1760 | /* Alias of mbedtls_ssl_pend_fatal_alert */ |
| 1761 | #define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \ |
| 1762 | mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value ) |
| 1763 | |
Hanno Becker | 7e8e6a6 | 2020-02-05 10:45:48 +0000 | [diff] [blame] | 1764 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
| 1765 | void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl ); |
| 1766 | #endif |
| 1767 | |
Hanno Becker | ce5f5fd | 2020-02-05 10:47:44 +0000 | [diff] [blame] | 1768 | void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl ); |
| 1769 | |
Hanno Becker | 08f0913 | 2020-02-11 15:40:07 +0000 | [diff] [blame] | 1770 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1771 | MBEDTLS_CHECK_RETURN_CRITICAL |
Hanno Becker | 40cdaa1 | 2020-02-05 10:48:27 +0000 | [diff] [blame] | 1772 | int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl ); |
Hanno Becker | 08f0913 | 2020-02-11 15:40:07 +0000 | [diff] [blame] | 1773 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Hanno Becker | 8949071 | 2020-02-05 10:50:12 +0000 | [diff] [blame] | 1774 | |
Hanno Becker | 533ab5f | 2020-02-05 10:49:13 +0000 | [diff] [blame] | 1775 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Hanno Becker | 08f0913 | 2020-02-11 15:40:07 +0000 | [diff] [blame] | 1776 | size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl ); |
Hanno Becker | 533ab5f | 2020-02-05 10:49:13 +0000 | [diff] [blame] | 1777 | void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl ); |
| 1778 | void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight ); |
| 1779 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 1780 | |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1781 | /** |
| 1782 | * ssl utils functions for checking configuration. |
| 1783 | */ |
| 1784 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1785 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1786 | static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf ) |
| 1787 | { |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 1788 | return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 && |
| 1789 | conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 ); |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1790 | } |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 1791 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1792 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1793 | |
| 1794 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 1795 | static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf ) |
| 1796 | { |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 1797 | return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 && |
| 1798 | conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 ); |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1799 | } |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 1800 | |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1801 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 1802 | |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 1803 | static inline int mbedtls_ssl_conf_is_tls13_enabled( const mbedtls_ssl_config *conf ) |
| 1804 | { |
| 1805 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 1806 | return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 && |
| 1807 | conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3 ); |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 1808 | #else |
| 1809 | ((void) conf); |
| 1810 | return( 0 ); |
| 1811 | #endif |
| 1812 | } |
| 1813 | |
| 1814 | static inline int mbedtls_ssl_conf_is_tls12_enabled( const mbedtls_ssl_config *conf ) |
| 1815 | { |
| 1816 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 1817 | return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 && |
| 1818 | conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2 ); |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 1819 | #else |
| 1820 | ((void) conf); |
| 1821 | return( 0 ); |
| 1822 | #endif |
| 1823 | } |
| 1824 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1825 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1826 | static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf ) |
| 1827 | { |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 1828 | return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 && |
| 1829 | conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 ); |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1830 | } |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1831 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */ |
Jerry Yu | 60835a8 | 2021-08-04 10:13:52 +0800 | [diff] [blame] | 1832 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1833 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | fbe3e64 | 2022-04-25 19:31:51 +0800 | [diff] [blame] | 1834 | extern const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[ |
| 1835 | MBEDTLS_SERVER_HELLO_RANDOM_LEN ]; |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1836 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | a6e6c27 | 2021-11-17 17:54:13 +0800 | [diff] [blame] | 1837 | int mbedtls_ssl_tls13_process_finished_message( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1838 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | a6e6c27 | 2021-11-17 17:54:13 +0800 | [diff] [blame] | 1839 | int mbedtls_ssl_tls13_write_finished_message( mbedtls_ssl_context *ssl ); |
| 1840 | void mbedtls_ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl ); |
| 1841 | |
| 1842 | /** |
Ronald Cron | 3d580bf | 2022-02-18 17:24:56 +0100 | [diff] [blame] | 1843 | * \brief Given an SSL context and its associated configuration, write the TLS |
| 1844 | * 1.3 specific extensions of the ClientHello message. |
| 1845 | * |
| 1846 | * \param[in] ssl SSL context |
| 1847 | * \param[in] buf Base address of the buffer where to write the extensions |
| 1848 | * \param[in] end End address of the buffer where to write the extensions |
| 1849 | * \param[out] out_len Length of the data written into the buffer \p buf |
| 1850 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1851 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 3d580bf | 2022-02-18 17:24:56 +0100 | [diff] [blame] | 1852 | int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl, |
| 1853 | unsigned char *buf, |
| 1854 | unsigned char *end, |
| 1855 | size_t *out_len ); |
| 1856 | |
| 1857 | /** |
Jerry Yu | a6e6c27 | 2021-11-17 17:54:13 +0800 | [diff] [blame] | 1858 | * \brief TLS 1.3 client side state machine entry |
| 1859 | * |
| 1860 | * \param ssl SSL context |
| 1861 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1862 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | a6e6c27 | 2021-11-17 17:54:13 +0800 | [diff] [blame] | 1863 | int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl ); |
| 1864 | |
| 1865 | /** |
| 1866 | * \brief TLS 1.3 server side state machine entry |
| 1867 | * |
| 1868 | * \param ssl SSL context |
| 1869 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 1870 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | a6e6c27 | 2021-11-17 17:54:13 +0800 | [diff] [blame] | 1871 | int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl ); |
| 1872 | |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1873 | |
| 1874 | /* |
| 1875 | * Helper functions around key exchange modes. |
| 1876 | */ |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1877 | static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl, |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1878 | int kex_mode_mask ) |
| 1879 | { |
| 1880 | return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 ); |
| 1881 | } |
| 1882 | |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1883 | static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1884 | { |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1885 | return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1886 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) ); |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1887 | } |
| 1888 | |
| 1889 | static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl ) |
| 1890 | { |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1891 | return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1892 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) ); |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1893 | } |
| 1894 | |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1895 | static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1896 | { |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1897 | return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1898 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) ); |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1899 | } |
| 1900 | |
| 1901 | static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl ) |
| 1902 | { |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1903 | return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1904 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) ); |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1905 | } |
| 1906 | |
| 1907 | static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl ) |
| 1908 | { |
Jerry Yu | b60e3cf | 2021-09-08 16:41:02 +0800 | [diff] [blame] | 1909 | return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1910 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) ); |
Jerry Yu | 26f4d15 | 2021-08-23 17:42:37 +0800 | [diff] [blame] | 1911 | } |
| 1912 | |
Ronald Cron | 41a443a | 2022-10-04 16:38:25 +0200 | [diff] [blame] | 1913 | #if defined(MBEDTLS_SSL_SRV_C) && \ |
| 1914 | defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED) |
Jerry Yu | adf861a | 2021-09-29 21:22:08 +0800 | [diff] [blame] | 1915 | /** |
| 1916 | * Given a list of key exchange modes, check if at least one of them is |
| 1917 | * supported. |
| 1918 | * |
| 1919 | * \param[in] ssl SSL context |
Jerry Yu | 0cabad3 | 2021-09-30 09:52:35 +0800 | [diff] [blame] | 1920 | * \param kex_modes_mask Mask of the key exchange modes to check |
Jerry Yu | adf861a | 2021-09-29 21:22:08 +0800 | [diff] [blame] | 1921 | * |
| 1922 | * \return 0 if at least one of the key exchange modes is supported, |
Jerry Yu | dca3d5d | 2021-10-08 14:19:29 +0800 | [diff] [blame] | 1923 | * !=0 otherwise. |
Jerry Yu | adf861a | 2021-09-29 21:22:08 +0800 | [diff] [blame] | 1924 | */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1925 | static inline unsigned mbedtls_ssl_tls13_check_kex_modes( mbedtls_ssl_context *ssl, |
| 1926 | int kex_modes_mask ) |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1927 | { |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1928 | return( ( ssl->handshake->tls13_kex_modes & kex_modes_mask ) == 0 ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1929 | } |
| 1930 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1931 | static inline int mbedtls_ssl_tls13_psk_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1932 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1933 | return( ! mbedtls_ssl_tls13_check_kex_modes( ssl, |
| 1934 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1935 | } |
| 1936 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1937 | static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled( |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1938 | mbedtls_ssl_context *ssl ) |
| 1939 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1940 | return( ! mbedtls_ssl_tls13_check_kex_modes( ssl, |
| 1941 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1942 | } |
| 1943 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1944 | static inline int mbedtls_ssl_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1945 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1946 | return( ! mbedtls_ssl_tls13_check_kex_modes( ssl, |
| 1947 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1948 | } |
| 1949 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1950 | static inline int mbedtls_ssl_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1951 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1952 | return( ! mbedtls_ssl_tls13_check_kex_modes( ssl, |
| 1953 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1954 | } |
| 1955 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1956 | static inline int mbedtls_ssl_tls13_some_psk_enabled( mbedtls_ssl_context *ssl ) |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1957 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1958 | return( ! mbedtls_ssl_tls13_check_kex_modes( ssl, |
| 1959 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) ); |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1960 | } |
Ronald Cron | 41a443a | 2022-10-04 16:38:25 +0200 | [diff] [blame] | 1961 | #endif /* MBEDTLS_SSL_SRV_C && |
| 1962 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */ |
Jerry Yu | 1b7c4a4 | 2021-09-09 17:09:12 +0800 | [diff] [blame] | 1963 | |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 1964 | /* |
Jerry Yu | ea52ed9 | 2022-11-08 21:01:17 +0800 | [diff] [blame] | 1965 | * Helper functions for extensions checking. |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 1966 | */ |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 1967 | |
Jerry Yu | 0c354a2 | 2022-08-29 15:25:36 +0800 | [diff] [blame] | 1968 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | c4bf5d6 | 2022-10-29 09:08:47 +0800 | [diff] [blame] | 1969 | int mbedtls_ssl_tls13_check_received_extension( |
| 1970 | mbedtls_ssl_context *ssl, |
| 1971 | int hs_msg_type, |
| 1972 | unsigned int received_extension_type, |
| 1973 | uint32_t hs_msg_allowed_extensions_mask ); |
Jerry Yu | 0c354a2 | 2022-08-29 15:25:36 +0800 | [diff] [blame] | 1974 | |
Jerry Yu | c4bf5d6 | 2022-10-29 09:08:47 +0800 | [diff] [blame] | 1975 | static inline void mbedtls_ssl_tls13_set_hs_sent_ext_mask( |
| 1976 | mbedtls_ssl_context *ssl, unsigned int extension_type ) |
Jerry Yu | 0c354a2 | 2022-08-29 15:25:36 +0800 | [diff] [blame] | 1977 | { |
| 1978 | ssl->handshake->sent_extensions |= |
Jerry Yu | 7a485c1 | 2022-10-31 13:08:18 +0800 | [diff] [blame] | 1979 | mbedtls_ssl_get_extension_mask( extension_type ); |
Jerry Yu | 0c354a2 | 2022-08-29 15:25:36 +0800 | [diff] [blame] | 1980 | } |
Jerry Yu | e18dc7e | 2022-08-04 16:29:22 +0800 | [diff] [blame] | 1981 | |
| 1982 | /* |
Ronald Cron | 8538549 | 2022-07-20 16:44:00 +0200 | [diff] [blame] | 1983 | * Helper functions to check the selected key exchange mode. |
| 1984 | */ |
| 1985 | static inline int mbedtls_ssl_tls13_key_exchange_mode_check( |
| 1986 | mbedtls_ssl_context *ssl, int kex_mask ) |
| 1987 | { |
| 1988 | return( ( ssl->handshake->key_exchange_mode & kex_mask ) != 0 ); |
| 1989 | } |
| 1990 | |
| 1991 | static inline int mbedtls_ssl_tls13_key_exchange_mode_with_psk( |
| 1992 | mbedtls_ssl_context *ssl ) |
| 1993 | { |
| 1994 | return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl, |
| 1995 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) ); |
| 1996 | } |
| 1997 | |
| 1998 | static inline int mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( |
| 1999 | mbedtls_ssl_context *ssl ) |
| 2000 | { |
| 2001 | return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl, |
| 2002 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) ); |
| 2003 | } |
| 2004 | |
| 2005 | /* |
XiaokangQian | 6b226b0 | 2021-09-24 07:51:16 +0000 | [diff] [blame] | 2006 | * Fetch TLS 1.3 handshake message header |
| 2007 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2008 | MBEDTLS_CHECK_RETURN_CRITICAL |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 2009 | int mbedtls_ssl_tls13_fetch_handshake_msg( mbedtls_ssl_context *ssl, |
| 2010 | unsigned hs_type, |
| 2011 | unsigned char **buf, |
| 2012 | size_t *buf_len ); |
XiaokangQian | 6b226b0 | 2021-09-24 07:51:16 +0000 | [diff] [blame] | 2013 | |
| 2014 | /* |
Xiaofei Bai | 947571e | 2021-09-29 09:12:03 +0000 | [diff] [blame] | 2015 | * Handler of TLS 1.3 server certificate message |
| 2016 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2017 | MBEDTLS_CHECK_RETURN_CRITICAL |
Xiaofei Bai | 947571e | 2021-09-29 09:12:03 +0000 | [diff] [blame] | 2018 | int mbedtls_ssl_tls13_process_certificate( mbedtls_ssl_context *ssl ); |
| 2019 | |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2020 | #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 2021 | /* |
Jerry Yu | 3e53644 | 2022-02-15 11:05:59 +0800 | [diff] [blame] | 2022 | * Handler of TLS 1.3 write Certificate message |
Jerry Yu | 5cc3506 | 2022-01-28 16:16:08 +0800 | [diff] [blame] | 2023 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2024 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | 5cc3506 | 2022-01-28 16:16:08 +0800 | [diff] [blame] | 2025 | int mbedtls_ssl_tls13_write_certificate( mbedtls_ssl_context *ssl ); |
| 2026 | |
| 2027 | /* |
Jerry Yu | 3e53644 | 2022-02-15 11:05:59 +0800 | [diff] [blame] | 2028 | * Handler of TLS 1.3 write Certificate Verify message |
Jerry Yu | 8511f12 | 2022-01-29 10:01:04 +0800 | [diff] [blame] | 2029 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2030 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | 8511f12 | 2022-01-29 10:01:04 +0800 | [diff] [blame] | 2031 | int mbedtls_ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl ); |
Jerry Yu | 90f152d | 2022-01-29 22:12:42 +0800 | [diff] [blame] | 2032 | |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2033 | #endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */ |
Jerry Yu | 90f152d | 2022-01-29 22:12:42 +0800 | [diff] [blame] | 2034 | |
Jerry Yu | 8511f12 | 2022-01-29 10:01:04 +0800 | [diff] [blame] | 2035 | /* |
Jerry Yu | 30b071c | 2021-09-12 20:16:03 +0800 | [diff] [blame] | 2036 | * Generic handler of Certificate Verify |
| 2037 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2038 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | 30b071c | 2021-09-12 20:16:03 +0800 | [diff] [blame] | 2039 | int mbedtls_ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl ); |
| 2040 | |
| 2041 | /* |
Ronald Cron | 49ad619 | 2021-11-24 16:25:31 +0100 | [diff] [blame] | 2042 | * Write of dummy-CCS's for middlebox compatibility |
| 2043 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2044 | MBEDTLS_CHECK_RETURN_CRITICAL |
Ronald Cron | 49ad619 | 2021-11-24 16:25:31 +0100 | [diff] [blame] | 2045 | int mbedtls_ssl_tls13_write_change_cipher_spec( mbedtls_ssl_context *ssl ); |
| 2046 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2047 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | 647719a | 2021-12-07 09:16:29 +0000 | [diff] [blame] | 2048 | int mbedtls_ssl_reset_transcript_for_hrr( mbedtls_ssl_context *ssl ); |
| 2049 | |
Jerry Yu | 89e103c | 2022-03-30 22:43:29 +0800 | [diff] [blame] | 2050 | #if defined(MBEDTLS_ECDH_C) |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2051 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | 89e103c | 2022-03-30 22:43:29 +0800 | [diff] [blame] | 2052 | int mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange( |
| 2053 | mbedtls_ssl_context *ssl, |
| 2054 | uint16_t named_group, |
| 2055 | unsigned char *buf, |
| 2056 | unsigned char *end, |
| 2057 | size_t *out_len ); |
| 2058 | #endif /* MBEDTLS_ECDH_C */ |
| 2059 | |
Xiaokang Qian | 0e97d4d | 2022-10-24 11:12:51 +0000 | [diff] [blame] | 2060 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
| 2061 | int mbedtls_ssl_tls13_write_early_data_ext( |
| 2062 | mbedtls_ssl_context *ssl, |
| 2063 | unsigned char *buf, const unsigned char *end, size_t *olen); |
| 2064 | #endif /* MBEDTLS_SSL_EARLY_DATA */ |
Jerry Yu | 89e103c | 2022-03-30 22:43:29 +0800 | [diff] [blame] | 2065 | |
Jerry Yu | f017ee4 | 2022-01-12 15:49:48 +0800 | [diff] [blame] | 2066 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
| 2067 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2068 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Jerry Yu | 5cc8f0a | 2021-08-27 17:21:44 +0800 | [diff] [blame] | 2069 | /* |
Gabor Mezei | 53a3b14 | 2022-05-10 13:20:55 +0200 | [diff] [blame] | 2070 | * Parse TLS Signature Algorithm extension |
Xiaofei Bai | 69fcd39 | 2022-01-20 08:25:00 +0000 | [diff] [blame] | 2071 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2072 | MBEDTLS_CHECK_RETURN_CRITICAL |
Gabor Mezei | 078e803 | 2022-04-27 21:17:56 +0200 | [diff] [blame] | 2073 | int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl, |
| 2074 | const unsigned char *buf, |
| 2075 | const unsigned char *end ); |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2076 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Jerry Yu | 65dd2cc | 2021-08-18 16:38:40 +0800 | [diff] [blame] | 2077 | |
Jerry Yu | 000f976 | 2021-09-14 11:12:51 +0800 | [diff] [blame] | 2078 | /* Get handshake transcript */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2079 | MBEDTLS_CHECK_RETURN_CRITICAL |
Jerry Yu | 000f976 | 2021-09-14 11:12:51 +0800 | [diff] [blame] | 2080 | int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl, |
| 2081 | const mbedtls_md_type_t md, |
| 2082 | unsigned char *dst, |
| 2083 | size_t dst_len, |
| 2084 | size_t *olen ); |
| 2085 | |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 2086 | /* |
| 2087 | * Return supported groups. |
| 2088 | * |
| 2089 | * In future, invocations can be changed to ssl->conf->group_list |
| 2090 | * when mbedtls_ssl_conf_curves() is deleted. |
| 2091 | * |
| 2092 | * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group |
| 2093 | * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to |
| 2094 | * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked. |
| 2095 | * |
| 2096 | */ |
| 2097 | static inline const void *mbedtls_ssl_get_groups( const mbedtls_ssl_context *ssl ) |
| 2098 | { |
| 2099 | #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C) |
| 2100 | return( ssl->conf->group_list ); |
| 2101 | #else |
| 2102 | if( ( ssl->handshake != NULL ) && ( ssl->handshake->group_list != NULL ) ) |
| 2103 | return( ssl->handshake->group_list ); |
| 2104 | else |
| 2105 | return( ssl->conf->group_list ); |
| 2106 | #endif |
| 2107 | } |
| 2108 | |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2109 | /* |
| 2110 | * Helper functions for NamedGroup. |
| 2111 | */ |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 2112 | static inline int mbedtls_ssl_tls12_named_group_is_ecdhe( uint16_t named_group ) |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2113 | { |
| 2114 | /* |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 2115 | * RFC 8422 section 5.1.1 |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2116 | */ |
Jerry Yu | f0fede5 | 2022-01-12 10:57:47 +0800 | [diff] [blame] | 2117 | return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 || |
| 2118 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 || |
| 2119 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 || |
| 2120 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 || |
| 2121 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 || |
Andrzej Kurek | 5c65c57 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 2122 | /* Below deprecated curves should be removed with notice to users */ |
Jerry Yu | f0fede5 | 2022-01-12 10:57:47 +0800 | [diff] [blame] | 2123 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 || |
Jerry Yu | 3ad14ac | 2022-01-11 17:13:16 +0800 | [diff] [blame] | 2124 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 || |
| 2125 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 || |
| 2126 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 || |
| 2127 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 || |
| 2128 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 || |
| 2129 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 || |
Jerry Yu | f0fede5 | 2022-01-12 10:57:47 +0800 | [diff] [blame] | 2130 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ); |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2131 | } |
| 2132 | |
| 2133 | static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group ) |
| 2134 | { |
Jerry Yu | f0fede5 | 2022-01-12 10:57:47 +0800 | [diff] [blame] | 2135 | return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 || |
| 2136 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 || |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2137 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 || |
| 2138 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 || |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2139 | named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ); |
| 2140 | } |
| 2141 | |
| 2142 | static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group ) |
| 2143 | { |
| 2144 | return( named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 && |
| 2145 | named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 ); |
| 2146 | } |
| 2147 | |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 2148 | static inline int mbedtls_ssl_named_group_is_offered( |
| 2149 | const mbedtls_ssl_context *ssl, uint16_t named_group ) |
| 2150 | { |
| 2151 | const uint16_t *group_list = mbedtls_ssl_get_groups( ssl ); |
| 2152 | |
| 2153 | if( group_list == NULL ) |
| 2154 | return( 0 ); |
| 2155 | |
| 2156 | for( ; *group_list != 0; group_list++ ) |
| 2157 | { |
| 2158 | if( *group_list == named_group ) |
| 2159 | return( 1 ); |
| 2160 | } |
| 2161 | |
| 2162 | return( 0 ); |
| 2163 | } |
| 2164 | |
| 2165 | static inline int mbedtls_ssl_named_group_is_supported( uint16_t named_group ) |
| 2166 | { |
| 2167 | #if defined(MBEDTLS_ECDH_C) |
| 2168 | if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) ) |
| 2169 | { |
| 2170 | const mbedtls_ecp_curve_info *curve_info = |
| 2171 | mbedtls_ecp_curve_info_from_tls_id( named_group ); |
| 2172 | if( curve_info != NULL ) |
| 2173 | return( 1 ); |
| 2174 | } |
| 2175 | #else |
| 2176 | ((void) named_group); |
| 2177 | #endif /* MBEDTLS_ECDH_C */ |
| 2178 | return( 0 ); |
| 2179 | } |
| 2180 | |
Jerry Yu | afdfed1 | 2021-12-22 10:49:02 +0800 | [diff] [blame] | 2181 | /* |
Jerry Yu | 713013f | 2022-01-17 18:16:35 +0800 | [diff] [blame] | 2182 | * Return supported signature algorithms. |
| 2183 | * |
| 2184 | * In future, invocations can be changed to ssl->conf->sig_algs when |
| 2185 | * mbedtls_ssl_conf_sig_hashes() is deleted. |
| 2186 | * |
Jerry Yu | 7ddc38c | 2022-01-19 11:08:05 +0800 | [diff] [blame] | 2187 | * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS |
| 2188 | * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been |
| 2189 | * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has |
| 2190 | * been more recently invoked. |
| 2191 | * |
Jerry Yu | afdfed1 | 2021-12-22 10:49:02 +0800 | [diff] [blame] | 2192 | */ |
Jerry Yu | 713013f | 2022-01-17 18:16:35 +0800 | [diff] [blame] | 2193 | static inline const void *mbedtls_ssl_get_sig_algs( |
| 2194 | const mbedtls_ssl_context *ssl ) |
Jerry Yu | afdfed1 | 2021-12-22 10:49:02 +0800 | [diff] [blame] | 2195 | { |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2196 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Manuel Pégourié-Gonnard | f7d704d | 2022-01-28 10:05:56 +0100 | [diff] [blame] | 2197 | |
Jerry Yu | 6106fdc | 2022-01-12 16:36:14 +0800 | [diff] [blame] | 2198 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
Jerry Yu | cc53910 | 2022-06-27 16:27:35 +0800 | [diff] [blame] | 2199 | if( ssl->handshake != NULL && |
| 2200 | ssl->handshake->sig_algs_heap_allocated == 1 && |
Jerry Yu | ee28e7a | 2022-06-24 19:35:40 +0800 | [diff] [blame] | 2201 | ssl->handshake->sig_algs != NULL ) |
| 2202 | { |
Jerry Yu | 6106fdc | 2022-01-12 16:36:14 +0800 | [diff] [blame] | 2203 | return( ssl->handshake->sig_algs ); |
Jerry Yu | ee28e7a | 2022-06-24 19:35:40 +0800 | [diff] [blame] | 2204 | } |
Jerry Yu | 6106fdc | 2022-01-12 16:36:14 +0800 | [diff] [blame] | 2205 | #endif |
| 2206 | return( ssl->conf->sig_algs ); |
Manuel Pégourié-Gonnard | f7d704d | 2022-01-28 10:05:56 +0100 | [diff] [blame] | 2207 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2208 | #else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Jerry Yu | afdfed1 | 2021-12-22 10:49:02 +0800 | [diff] [blame] | 2209 | |
Jerry Yu | 6106fdc | 2022-01-12 16:36:14 +0800 | [diff] [blame] | 2210 | ((void) ssl); |
Jerry Yu | 713013f | 2022-01-17 18:16:35 +0800 | [diff] [blame] | 2211 | return( NULL ); |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2212 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Jerry Yu | afdfed1 | 2021-12-22 10:49:02 +0800 | [diff] [blame] | 2213 | } |
Jerry Yu | ba07342 | 2021-12-20 22:22:15 +0800 | [diff] [blame] | 2214 | |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2215 | #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) |
Jerry Yu | 8511f12 | 2022-01-29 10:01:04 +0800 | [diff] [blame] | 2216 | static inline int mbedtls_ssl_sig_alg_is_received( const mbedtls_ssl_context *ssl, |
| 2217 | uint16_t own_sig_alg ) |
| 2218 | { |
Jerry Yu | 1bb5a1f | 2022-01-30 10:52:11 +0800 | [diff] [blame] | 2219 | const uint16_t *sig_alg = ssl->handshake->received_sig_algs; |
| 2220 | if( sig_alg == NULL ) |
| 2221 | return( 0 ); |
| 2222 | |
Gabor Mezei | 15b95a6 | 2022-05-09 16:37:58 +0200 | [diff] [blame] | 2223 | for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ ) |
Jerry Yu | 1bb5a1f | 2022-01-30 10:52:11 +0800 | [diff] [blame] | 2224 | { |
| 2225 | if( *sig_alg == own_sig_alg ) |
| 2226 | return( 1 ); |
| 2227 | } |
| 2228 | return( 0 ); |
Jerry Yu | 8511f12 | 2022-01-29 10:01:04 +0800 | [diff] [blame] | 2229 | } |
| 2230 | |
Jerry Yu | a1255e6 | 2022-06-24 10:10:47 +0800 | [diff] [blame] | 2231 | static inline int mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2232 | const uint16_t sig_alg ) |
| 2233 | { |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2234 | switch( sig_alg ) |
| 2235 | { |
| 2236 | #if defined(MBEDTLS_ECDSA_C) |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2237 | #if defined(PSA_WANT_ALG_SHA_256) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2238 | case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256: |
| 2239 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2240 | #endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_ECP_DP_SECP256R1_ENABLED */ |
| 2241 | #if defined(PSA_WANT_ALG_SHA_384) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2242 | case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384: |
| 2243 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2244 | #endif /* PSA_WANT_ALG_SHA_384 && MBEDTLS_ECP_DP_SECP384R1_ENABLED */ |
| 2245 | #if defined(PSA_WANT_ALG_SHA_512) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2246 | case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512: |
| 2247 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2248 | #endif /* PSA_WANT_ALG_SHA_512 && MBEDTLS_ECP_DP_SECP521R1_ENABLED */ |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2249 | #endif /* MBEDTLS_ECDSA_C */ |
| 2250 | |
Jerry Yu | 52b7d92 | 2022-07-01 18:03:31 +0800 | [diff] [blame] | 2251 | #if defined(MBEDTLS_PKCS1_V21) |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2252 | #if defined(PSA_WANT_ALG_SHA_256) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2253 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256: |
| 2254 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2255 | #endif /* PSA_WANT_ALG_SHA_256 */ |
| 2256 | #if defined(PSA_WANT_ALG_SHA_384) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2257 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384: |
| 2258 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2259 | #endif /* PSA_WANT_ALG_SHA_384 */ |
| 2260 | #if defined(PSA_WANT_ALG_SHA_512) |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2261 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512: |
| 2262 | break; |
Przemyslaw Stekiel | 004c218 | 2022-09-14 09:09:16 +0200 | [diff] [blame] | 2263 | #endif /* PSA_WANT_ALG_SHA_512 */ |
Jerry Yu | 52b7d92 | 2022-07-01 18:03:31 +0800 | [diff] [blame] | 2264 | #endif /* MBEDTLS_PKCS1_V21 */ |
Jerry Yu | 96ee23e | 2022-06-21 16:34:57 +0800 | [diff] [blame] | 2265 | default: |
| 2266 | return( 0 ); |
| 2267 | } |
| 2268 | return( 1 ); |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2269 | |
| 2270 | } |
| 2271 | |
| 2272 | static inline int mbedtls_ssl_tls13_sig_alg_is_supported( |
| 2273 | const uint16_t sig_alg ) |
| 2274 | { |
| 2275 | switch( sig_alg ) |
| 2276 | { |
Jerry Yu | 52b7d92 | 2022-07-01 18:03:31 +0800 | [diff] [blame] | 2277 | #if defined(MBEDTLS_PKCS1_V15) |
Przemek Stekiel | 153b442 | 2022-09-05 12:36:25 +0200 | [diff] [blame] | 2278 | #if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2279 | case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256: |
| 2280 | break; |
Przemek Stekiel | 153b442 | 2022-09-05 12:36:25 +0200 | [diff] [blame] | 2281 | #endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
| 2282 | #if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2283 | case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384: |
| 2284 | break; |
Przemek Stekiel | 153b442 | 2022-09-05 12:36:25 +0200 | [diff] [blame] | 2285 | #endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
| 2286 | #if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2287 | case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512: |
| 2288 | break; |
Przemek Stekiel | 153b442 | 2022-09-05 12:36:25 +0200 | [diff] [blame] | 2289 | #endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
Jerry Yu | 52b7d92 | 2022-07-01 18:03:31 +0800 | [diff] [blame] | 2290 | #endif /* MBEDTLS_PKCS1_V15 */ |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2291 | default: |
Jerry Yu | a1255e6 | 2022-06-24 10:10:47 +0800 | [diff] [blame] | 2292 | return( mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( |
Jerry Yu | 80dd5db | 2022-06-22 19:30:32 +0800 | [diff] [blame] | 2293 | sig_alg ) ); |
| 2294 | } |
| 2295 | return( 1 ); |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2296 | } |
Xiaokang Qian | a3b451f | 2022-10-11 06:20:56 +0000 | [diff] [blame] | 2297 | |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2298 | MBEDTLS_CHECK_RETURN_CRITICAL |
| 2299 | int mbedtls_ssl_tls13_check_sig_alg_cert_key_match( uint16_t sig_alg, |
| 2300 | mbedtls_pk_context *key ); |
| 2301 | #endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */ |
| 2302 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2303 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2304 | static inline int mbedtls_ssl_sig_alg_is_offered( const mbedtls_ssl_context *ssl, |
| 2305 | uint16_t proposed_sig_alg ) |
| 2306 | { |
| 2307 | const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl ); |
| 2308 | if( sig_alg == NULL ) |
| 2309 | return( 0 ); |
| 2310 | |
| 2311 | for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ ) |
| 2312 | { |
| 2313 | if( *sig_alg == proposed_sig_alg ) |
| 2314 | return( 1 ); |
| 2315 | } |
| 2316 | return( 0 ); |
| 2317 | } |
| 2318 | |
| 2319 | static inline int mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg( |
| 2320 | uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg ) |
| 2321 | { |
| 2322 | *pk_type = mbedtls_ssl_pk_alg_from_sig( sig_alg & 0xff ); |
| 2323 | *md_alg = mbedtls_ssl_md_alg_from_hash( ( sig_alg >> 8 ) & 0xff ); |
| 2324 | |
| 2325 | if( *pk_type != MBEDTLS_PK_NONE && *md_alg != MBEDTLS_MD_NONE ) |
| 2326 | return( 0 ); |
| 2327 | |
| 2328 | switch( sig_alg ) |
| 2329 | { |
| 2330 | #if defined(MBEDTLS_PKCS1_V21) |
| 2331 | #if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
| 2332 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256: |
| 2333 | *md_alg = MBEDTLS_MD_SHA256; |
| 2334 | *pk_type = MBEDTLS_PK_RSASSA_PSS; |
| 2335 | break; |
| 2336 | #endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
| 2337 | #if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
| 2338 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384: |
| 2339 | *md_alg = MBEDTLS_MD_SHA384; |
| 2340 | *pk_type = MBEDTLS_PK_RSASSA_PSS; |
| 2341 | break; |
| 2342 | #endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
| 2343 | #if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
| 2344 | case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512: |
| 2345 | *md_alg = MBEDTLS_MD_SHA512; |
| 2346 | *pk_type = MBEDTLS_PK_RSASSA_PSS; |
| 2347 | break; |
| 2348 | #endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */ |
| 2349 | #endif /* MBEDTLS_PKCS1_V21 */ |
| 2350 | default: |
| 2351 | return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE ); |
| 2352 | } |
| 2353 | return( 0 ); |
| 2354 | } |
Jerry Yu | 8c33886 | 2022-03-23 13:34:04 +0800 | [diff] [blame] | 2355 | |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2356 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 2357 | static inline int mbedtls_ssl_tls12_sig_alg_is_supported( |
| 2358 | const uint16_t sig_alg ) |
| 2359 | { |
| 2360 | /* High byte is hash */ |
| 2361 | unsigned char hash = MBEDTLS_BYTE_1( sig_alg ); |
| 2362 | unsigned char sig = MBEDTLS_BYTE_0( sig_alg ); |
| 2363 | |
| 2364 | switch( hash ) |
| 2365 | { |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2366 | #if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2367 | case MBEDTLS_SSL_HASH_MD5: |
| 2368 | break; |
| 2369 | #endif |
| 2370 | |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2371 | #if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2372 | case MBEDTLS_SSL_HASH_SHA1: |
| 2373 | break; |
| 2374 | #endif |
| 2375 | |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2376 | #if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2377 | case MBEDTLS_SSL_HASH_SHA224: |
| 2378 | break; |
| 2379 | #endif |
| 2380 | |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2381 | #if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2382 | case MBEDTLS_SSL_HASH_SHA256: |
| 2383 | break; |
| 2384 | #endif |
| 2385 | |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2386 | #if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2387 | case MBEDTLS_SSL_HASH_SHA384: |
| 2388 | break; |
| 2389 | #endif |
| 2390 | |
Andrzej Kurek | 25f2715 | 2022-08-17 16:09:31 -0400 | [diff] [blame] | 2391 | #if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2392 | case MBEDTLS_SSL_HASH_SHA512: |
| 2393 | break; |
| 2394 | #endif |
| 2395 | |
| 2396 | default: |
| 2397 | return( 0 ); |
| 2398 | } |
| 2399 | |
| 2400 | switch( sig ) |
| 2401 | { |
| 2402 | #if defined(MBEDTLS_RSA_C) |
| 2403 | case MBEDTLS_SSL_SIG_RSA: |
| 2404 | break; |
| 2405 | #endif |
| 2406 | |
| 2407 | #if defined(MBEDTLS_ECDSA_C) |
| 2408 | case MBEDTLS_SSL_SIG_ECDSA: |
| 2409 | break; |
| 2410 | #endif |
| 2411 | |
| 2412 | default: |
| 2413 | return( 0 ); |
| 2414 | } |
| 2415 | |
| 2416 | return( 1 ); |
| 2417 | } |
| 2418 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 2419 | |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2420 | static inline int mbedtls_ssl_sig_alg_is_supported( |
| 2421 | const mbedtls_ssl_context *ssl, |
| 2422 | const uint16_t sig_alg ) |
| 2423 | { |
| 2424 | |
| 2425 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Glenn Strauss | 60bfe60 | 2022-03-14 19:04:24 -0400 | [diff] [blame] | 2426 | if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 ) |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2427 | { |
Jerry Yu | 0ebce95 | 2022-06-16 13:54:47 +0800 | [diff] [blame] | 2428 | return( mbedtls_ssl_tls12_sig_alg_is_supported( sig_alg ) ); |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2429 | } |
| 2430 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 2431 | |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2432 | #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) |
Glenn Strauss | 60bfe60 | 2022-03-14 19:04:24 -0400 | [diff] [blame] | 2433 | if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 ) |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2434 | { |
Jerry Yu | 7ab7f2b | 2022-06-16 19:07:10 +0800 | [diff] [blame] | 2435 | return( mbedtls_ssl_tls13_sig_alg_is_supported( sig_alg ) ); |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2436 | } |
Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 2437 | #endif |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2438 | ((void) ssl); |
| 2439 | ((void) sig_alg); |
| 2440 | return( 0 ); |
| 2441 | } |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 2442 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2443 | |
Neil Armstrong | 8395d7a | 2022-05-18 11:44:56 +0200 | [diff] [blame] | 2444 | #if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2445 | /* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL. |
Andrzej Kurek | 5c65c57 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 2446 | * Same value is used for PSA_ALG_CATEGORY_CIPHER, hence it is |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2447 | * guaranteed to not be a valid PSA algorithm identifier. |
| 2448 | */ |
| 2449 | #define MBEDTLS_SSL_NULL_CIPHER 0x04000000 |
| 2450 | |
| 2451 | /** |
| 2452 | * \brief Translate mbedtls cipher type/taglen pair to psa: |
| 2453 | * algorithm, key type and key size. |
| 2454 | * |
| 2455 | * \param mbedtls_cipher_type [in] given mbedtls cipher type |
| 2456 | * \param taglen [in] given tag length |
| 2457 | * 0 - default tag length |
| 2458 | * \param alg [out] corresponding PSA alg |
| 2459 | * There is no corresponding PSA |
Przemyslaw Stekiel | 8c010eb | 2022-02-03 10:44:02 +0100 | [diff] [blame] | 2460 | * alg for MBEDTLS_CIPHER_NULL, so |
| 2461 | * in this case MBEDTLS_SSL_NULL_CIPHER |
| 2462 | * is returned via this parameter |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2463 | * \param key_type [out] corresponding PSA key type |
| 2464 | * \param key_size [out] corresponding PSA key size |
| 2465 | * |
| 2466 | * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if |
| 2467 | * conversion is not supported. |
| 2468 | */ |
| 2469 | psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type, |
| 2470 | size_t taglen, |
| 2471 | psa_algorithm_t *alg, |
| 2472 | psa_key_type_t *key_type, |
| 2473 | size_t *key_size ); |
| 2474 | |
| 2475 | /** |
| 2476 | * \brief Convert given PSA status to mbedtls error code. |
| 2477 | * |
| 2478 | * \param status [in] given PSA status |
| 2479 | * |
| 2480 | * \return corresponding mbedtls error code |
| 2481 | */ |
Przemyslaw Stekiel | 77aec8d | 2022-01-31 20:22:53 +0100 | [diff] [blame] | 2482 | static inline int psa_ssl_status_to_mbedtls( psa_status_t status ) |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2483 | { |
| 2484 | switch( status ) |
| 2485 | { |
| 2486 | case PSA_SUCCESS: |
| 2487 | return( 0 ); |
| 2488 | case PSA_ERROR_INSUFFICIENT_MEMORY: |
Gabor Mezei | 1bf075f | 2022-03-21 12:19:52 +0100 | [diff] [blame] | 2489 | return( MBEDTLS_ERR_SSL_ALLOC_FAILED ); |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2490 | case PSA_ERROR_NOT_SUPPORTED: |
Gabor Mezei | 1bf075f | 2022-03-21 12:19:52 +0100 | [diff] [blame] | 2491 | return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE ); |
Przemyslaw Stekiel | 89dad93 | 2022-01-31 09:18:07 +0100 | [diff] [blame] | 2492 | case PSA_ERROR_INVALID_SIGNATURE: |
| 2493 | return( MBEDTLS_ERR_SSL_INVALID_MAC ); |
Gabor Mezei | adfeadc | 2022-03-21 12:17:49 +0100 | [diff] [blame] | 2494 | case PSA_ERROR_INVALID_ARGUMENT: |
| 2495 | return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); |
| 2496 | case PSA_ERROR_BAD_STATE: |
| 2497 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
Przemek Stekiel | 8583627 | 2022-04-05 10:50:53 +0200 | [diff] [blame] | 2498 | case PSA_ERROR_BUFFER_TOO_SMALL: |
| 2499 | return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); |
Przemyslaw Stekiel | e5c2238 | 2022-01-25 00:56:34 +0100 | [diff] [blame] | 2500 | default: |
| 2501 | return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED ); |
| 2502 | } |
| 2503 | } |
Przemyslaw Stekiel | b15f33d | 2022-02-10 10:12:12 +0100 | [diff] [blame] | 2504 | #endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */ |
Jerry Yu | 1bab301 | 2022-01-19 17:43:22 +0800 | [diff] [blame] | 2505 | |
Neil Armstrong | 8a0f3e8 | 2022-03-30 10:57:37 +0200 | [diff] [blame] | 2506 | /** |
| 2507 | * \brief TLS record protection modes |
| 2508 | */ |
| 2509 | typedef enum { |
| 2510 | MBEDTLS_SSL_MODE_STREAM = 0, |
| 2511 | MBEDTLS_SSL_MODE_CBC, |
| 2512 | MBEDTLS_SSL_MODE_CBC_ETM, |
| 2513 | MBEDTLS_SSL_MODE_AEAD |
| 2514 | } mbedtls_ssl_mode_t; |
| 2515 | |
Neil Armstrong | ab555e0 | 2022-04-04 11:07:59 +0200 | [diff] [blame] | 2516 | mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform( |
Neil Armstrong | 8a0f3e8 | 2022-03-30 10:57:37 +0200 | [diff] [blame] | 2517 | const mbedtls_ssl_transform *transform ); |
| 2518 | |
Neil Armstrong | f2c82f0 | 2022-04-05 11:16:53 +0200 | [diff] [blame] | 2519 | #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM) |
Neil Armstrong | ab555e0 | 2022-04-04 11:07:59 +0200 | [diff] [blame] | 2520 | mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite( |
Neil Armstrong | 4bf4c86 | 2022-04-01 10:35:48 +0200 | [diff] [blame] | 2521 | int encrypt_then_mac, |
| 2522 | const mbedtls_ssl_ciphersuite_t *suite ); |
| 2523 | #else |
Neil Armstrong | ab555e0 | 2022-04-04 11:07:59 +0200 | [diff] [blame] | 2524 | mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite( |
Neil Armstrong | 4bf4c86 | 2022-04-01 10:35:48 +0200 | [diff] [blame] | 2525 | const mbedtls_ssl_ciphersuite_t *suite ); |
Neil Armstrong | f2c82f0 | 2022-04-05 11:16:53 +0200 | [diff] [blame] | 2526 | #endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */ |
Neil Armstrong | 4bf4c86 | 2022-04-01 10:35:48 +0200 | [diff] [blame] | 2527 | |
XiaokangQian | 9b5d04b | 2022-04-10 10:20:43 +0000 | [diff] [blame] | 2528 | #if defined(MBEDTLS_ECDH_C) |
| 2529 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2530 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | 9b5d04b | 2022-04-10 10:20:43 +0000 | [diff] [blame] | 2531 | int mbedtls_ssl_tls13_read_public_ecdhe_share( mbedtls_ssl_context *ssl, |
| 2532 | const unsigned char *buf, |
| 2533 | size_t buf_len ); |
| 2534 | |
| 2535 | #endif /* MBEDTLS_ECDH_C */ |
| 2536 | |
XiaokangQian | 0a1b54e | 2022-04-21 03:01:38 +0000 | [diff] [blame] | 2537 | static inline int mbedtls_ssl_tls13_cipher_suite_is_offered( |
| 2538 | mbedtls_ssl_context *ssl, int cipher_suite ) |
| 2539 | { |
| 2540 | const int *ciphersuite_list = ssl->conf->ciphersuite_list; |
| 2541 | |
| 2542 | /* Check whether we have offered this ciphersuite */ |
| 2543 | for ( size_t i = 0; ciphersuite_list[i] != 0; i++ ) |
| 2544 | { |
| 2545 | if( ciphersuite_list[i] == cipher_suite ) |
| 2546 | { |
| 2547 | return( 1 ); |
| 2548 | } |
| 2549 | } |
| 2550 | return( 0 ); |
| 2551 | } |
| 2552 | |
| 2553 | /** |
| 2554 | * \brief Validate cipher suite against config in SSL context. |
| 2555 | * |
| 2556 | * \param ssl SSL context |
| 2557 | * \param suite_info Cipher suite to validate |
| 2558 | * \param min_tls_version Minimal TLS version to accept a cipher suite |
| 2559 | * \param max_tls_version Maximal TLS version to accept a cipher suite |
| 2560 | * |
| 2561 | * \return 0 if valid, negative value otherwise. |
| 2562 | */ |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2563 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | 0a1b54e | 2022-04-21 03:01:38 +0000 | [diff] [blame] | 2564 | int mbedtls_ssl_validate_ciphersuite( |
| 2565 | const mbedtls_ssl_context *ssl, |
| 2566 | const mbedtls_ssl_ciphersuite_t *suite_info, |
| 2567 | mbedtls_ssl_protocol_version min_tls_version, |
| 2568 | mbedtls_ssl_protocol_version max_tls_version ); |
XiaokangQian | 0803755 | 2022-04-20 07:16:41 +0000 | [diff] [blame] | 2569 | |
Manuel Pégourié-Gonnard | a82a8b9 | 2022-06-17 10:53:58 +0200 | [diff] [blame] | 2570 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | eaf3651 | 2022-04-24 09:07:44 +0000 | [diff] [blame] | 2571 | int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf, |
| 2572 | const unsigned char *end, size_t *out_len ); |
| 2573 | |
XiaokangQian | 40a3523 | 2022-05-07 09:02:40 +0000 | [diff] [blame] | 2574 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
Ronald Cron | ce7d76e | 2022-07-08 18:56:49 +0200 | [diff] [blame] | 2575 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | 9b2b771 | 2022-05-17 02:57:00 +0000 | [diff] [blame] | 2576 | int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl, |
| 2577 | const unsigned char *buf, |
| 2578 | const unsigned char *end ); |
XiaokangQian | 40a3523 | 2022-05-07 09:02:40 +0000 | [diff] [blame] | 2579 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ |
| 2580 | |
XiaokangQian | acb3992 | 2022-06-17 10:18:48 +0000 | [diff] [blame] | 2581 | #if defined(MBEDTLS_SSL_ALPN) |
Ronald Cron | ce7d76e | 2022-07-08 18:56:49 +0200 | [diff] [blame] | 2582 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | acb3992 | 2022-06-17 10:18:48 +0000 | [diff] [blame] | 2583 | int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl, |
| 2584 | const unsigned char *buf, |
| 2585 | const unsigned char *end ); |
| 2586 | |
| 2587 | |
Ronald Cron | ce7d76e | 2022-07-08 18:56:49 +0200 | [diff] [blame] | 2588 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | acb3992 | 2022-06-17 10:18:48 +0000 | [diff] [blame] | 2589 | int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl, |
| 2590 | unsigned char *buf, |
| 2591 | unsigned char *end, |
XiaokangQian | c740345 | 2022-06-23 03:24:12 +0000 | [diff] [blame] | 2592 | size_t *out_len ); |
XiaokangQian | acb3992 | 2022-06-17 10:18:48 +0000 | [diff] [blame] | 2593 | #endif /* MBEDTLS_SSL_ALPN */ |
| 2594 | |
Andrzej Kurek | cfb0194 | 2022-06-06 13:08:23 -0400 | [diff] [blame] | 2595 | #if defined(MBEDTLS_TEST_HOOKS) |
Andrzej Kurek | 078e9bc | 2022-06-08 11:47:33 -0400 | [diff] [blame] | 2596 | int mbedtls_ssl_check_dtls_clihlo_cookie( |
Andrzej Kurek | cfb0194 | 2022-06-06 13:08:23 -0400 | [diff] [blame] | 2597 | mbedtls_ssl_context *ssl, |
| 2598 | const unsigned char *cli_id, size_t cli_id_len, |
| 2599 | const unsigned char *in, size_t in_len, |
| 2600 | unsigned char *obuf, size_t buf_len, size_t *olen ); |
| 2601 | #endif |
| 2602 | |
Ronald Cron | 41a443a | 2022-10-04 16:38:25 +0200 | [diff] [blame] | 2603 | #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED) |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2604 | /** |
| 2605 | * \brief Given an SSL context and its associated configuration, write the TLS |
| 2606 | * 1.3 specific Pre-Shared key extension. |
| 2607 | * |
| 2608 | * \param[in] ssl SSL context |
| 2609 | * \param[in] buf Base address of the buffer where to write the extension |
| 2610 | * \param[in] end End address of the buffer where to write the extension |
XiaokangQian | 008d2bf | 2022-07-14 07:54:01 +0000 | [diff] [blame] | 2611 | * \param[out] out_len Length in bytes of the Pre-Shared key extension: data |
| 2612 | * written into the buffer \p buf by this function plus |
| 2613 | * the length of the binders to be written. |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2614 | * \param[out] binders_len Length of the binders to be written at the end of |
XiaokangQian | 008d2bf | 2022-07-14 07:54:01 +0000 | [diff] [blame] | 2615 | * the extension. |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2616 | */ |
XiaokangQian | 8698195 | 2022-07-19 09:51:50 +0000 | [diff] [blame] | 2617 | MBEDTLS_CHECK_RETURN_CRITICAL |
XiaokangQian | 3ad67bf | 2022-07-21 02:26:21 +0000 | [diff] [blame] | 2618 | int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext( |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2619 | mbedtls_ssl_context *ssl, |
| 2620 | unsigned char *buf, unsigned char *end, |
| 2621 | size_t *out_len, size_t *binders_len ); |
| 2622 | |
| 2623 | /** |
| 2624 | * \brief Given an SSL context and its associated configuration, write the TLS |
| 2625 | * 1.3 specific Pre-Shared key extension binders at the end of the |
| 2626 | * ClientHello. |
| 2627 | * |
| 2628 | * \param[in] ssl SSL context |
XiaokangQian | 008d2bf | 2022-07-14 07:54:01 +0000 | [diff] [blame] | 2629 | * \param[in] buf Base address of the buffer where to write the binders |
| 2630 | * \param[in] end End address of the buffer where to write the binders |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2631 | */ |
XiaokangQian | 8698195 | 2022-07-19 09:51:50 +0000 | [diff] [blame] | 2632 | MBEDTLS_CHECK_RETURN_CRITICAL |
| 2633 | int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext( |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2634 | mbedtls_ssl_context *ssl, |
| 2635 | unsigned char *buf, unsigned char *end ); |
Ronald Cron | 41a443a | 2022-10-04 16:38:25 +0200 | [diff] [blame] | 2636 | #endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */ |
XiaokangQian | eb69aee | 2022-07-05 08:21:43 +0000 | [diff] [blame] | 2637 | |
Xiaokang Qian | a3b451f | 2022-10-11 06:20:56 +0000 | [diff] [blame] | 2638 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \ |
Xiaokang Qian | 0340929 | 2022-10-12 02:49:52 +0000 | [diff] [blame] | 2639 | defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
Xiaokang Qian | ed0620c | 2022-10-12 06:58:13 +0000 | [diff] [blame] | 2640 | defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \ |
Xiaokang Qian | ed3afcd | 2022-10-12 08:31:11 +0000 | [diff] [blame] | 2641 | defined(MBEDTLS_SSL_CLI_C) |
Xiaokang Qian | 0340929 | 2022-10-12 02:49:52 +0000 | [diff] [blame] | 2642 | MBEDTLS_CHECK_RETURN_CRITICAL |
Xiaokang Qian | a3b451f | 2022-10-11 06:20:56 +0000 | [diff] [blame] | 2643 | int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session, |
| 2644 | const char *hostname ); |
| 2645 | #endif |
| 2646 | |
Chris Jones | 84a773f | 2021-03-05 18:38:47 +0000 | [diff] [blame] | 2647 | #endif /* ssl_misc.h */ |