Mbed TLS v3.5.0
ssl_ciphersuites.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
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.
21  */
22 #ifndef MBEDTLS_SSL_CIPHERSUITES_H
23 #define MBEDTLS_SSL_CIPHERSUITES_H
24 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 
28 #include "mbedtls/pk.h"
29 #include "mbedtls/cipher.h"
30 #include "mbedtls/md.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * Supported ciphersuites (Official IANA names)
38  */
39 #define MBEDTLS_TLS_RSA_WITH_NULL_MD5 0x01
40 #define MBEDTLS_TLS_RSA_WITH_NULL_SHA 0x02
42 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA 0x2C
43 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA 0x2D
44 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA 0x2E
45 #define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA 0x2F
46 
47 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA 0x33
48 #define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA 0x35
49 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA 0x39
50 
51 #define MBEDTLS_TLS_RSA_WITH_NULL_SHA256 0x3B
52 #define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 0x3C
53 #define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 0x3D
55 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA 0x41
56 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA 0x45
57 
58 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 0x67
59 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 0x6B
61 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA 0x84
62 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA 0x88
63 
64 #define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA 0x8C
65 #define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA 0x8D
66 
67 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA 0x90
68 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA 0x91
69 
70 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA 0x94
71 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA 0x95
72 
73 #define MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 0x9C
74 #define MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 0x9D
75 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 0x9E
76 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 0x9F
78 #define MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 0xA8
79 #define MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 0xA9
80 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 0xAA
81 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 0xAB
82 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 0xAC
83 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 0xAD
85 #define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 0xAE
86 #define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 0xAF
87 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA256 0xB0
88 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA384 0xB1
90 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 0xB2
91 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 0xB3
92 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256 0xB4
93 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384 0xB5
95 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 0xB6
96 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 0xB7
97 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256 0xB8
98 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384 0xB9
100 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBA
101 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBE
103 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC0
104 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC4
106 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA 0xC001
107 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA 0xC004
108 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA 0xC005
109 
110 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA 0xC006
111 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009
112 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0xC00A
113 
114 #define MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA 0xC00B
115 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA 0xC00E
116 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA 0xC00F
117 
118 #define MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA 0xC010
119 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013
120 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014
121 
122 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023
123 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024
124 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 0xC025
125 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 0xC026
126 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027
127 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 0xC028
128 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 0xC029
129 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 0xC02A
131 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B
132 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C
133 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 0xC02D
134 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 0xC02E
135 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F
136 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030
137 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 0xC031
138 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 0xC032
140 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA 0xC035
141 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA 0xC036
142 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 0xC037
143 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 0xC038
144 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA 0xC039
145 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 0xC03A
146 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 0xC03B
147 
148 #define MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256 0xC03C
149 #define MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384 0xC03D
150 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC044
151 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC045
152 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC048
153 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC049
154 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC04A
155 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC04B
156 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC04C
157 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC04D
158 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 0xC04E
159 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 0xC04F
160 #define MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256 0xC050
161 #define MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384 0xC051
162 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC052
163 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC053
164 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05C
165 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05D
166 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05E
167 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05F
168 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC060
169 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC061
170 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 0xC062
171 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 0xC063
172 #define MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 0xC064
173 #define MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 0xC065
174 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC066
175 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC067
176 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 0xC068
177 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 0xC069
178 #define MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 0xC06A
179 #define MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 0xC06B
180 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 0xC06C
181 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 0xC06D
182 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 0xC06E
183 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 0xC06F
184 #define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC070
185 #define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC071
187 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC072
188 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC073
189 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC074
190 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC075
191 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC076
192 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC077
193 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC078
194 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC079
195 
196 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC07A
197 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC07B
198 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC07C
199 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC07D
200 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC086
201 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC087
202 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC088
203 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC089
204 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08A
205 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08B
206 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08C
207 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08D
209 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC08E
210 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC08F
211 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC090
212 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC091
213 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC092
214 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC093
216 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC094
217 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC095
218 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC096
219 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC097
220 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC098
221 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC099
222 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC09A
223 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC09B
224 
225 #define MBEDTLS_TLS_RSA_WITH_AES_128_CCM 0xC09C
226 #define MBEDTLS_TLS_RSA_WITH_AES_256_CCM 0xC09D
227 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CCM 0xC09E
228 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CCM 0xC09F
229 #define MBEDTLS_TLS_RSA_WITH_AES_128_CCM_8 0xC0A0
230 #define MBEDTLS_TLS_RSA_WITH_AES_256_CCM_8 0xC0A1
231 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CCM_8 0xC0A2
232 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CCM_8 0xC0A3
233 #define MBEDTLS_TLS_PSK_WITH_AES_128_CCM 0xC0A4
234 #define MBEDTLS_TLS_PSK_WITH_AES_256_CCM 0xC0A5
235 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CCM 0xC0A6
236 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CCM 0xC0A7
237 #define MBEDTLS_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8
238 #define MBEDTLS_TLS_PSK_WITH_AES_256_CCM_8 0xC0A9
239 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CCM_8 0xC0AA
240 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CCM_8 0xC0AB
241 /* The last two are named with PSK_DHE in the RFC, which looks like a typo */
242 
243 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM 0xC0AC
244 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM 0xC0AD
245 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
246 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 0xC0AF
248 #define MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 0xC0FF
250 /* RFC 7905 */
251 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8
252 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9
253 #define MBEDTLS_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCAA
254 #define MBEDTLS_TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAB
255 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAC
256 #define MBEDTLS_TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAD
257 #define MBEDTLS_TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAE
259 /* RFC 8446, Appendix B.4 */
260 #define MBEDTLS_TLS1_3_AES_128_GCM_SHA256 0x1301
261 #define MBEDTLS_TLS1_3_AES_256_GCM_SHA384 0x1302
262 #define MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256 0x1303
263 #define MBEDTLS_TLS1_3_AES_128_CCM_SHA256 0x1304
264 #define MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256 0x1305
266 /* Reminder: update mbedtls_ssl_premaster_secret when adding a new key exchange.
267  * Reminder: update MBEDTLS_KEY_EXCHANGE__xxx below
268  */
269 typedef enum {
283 
284 /* Key exchanges using a certificate */
285 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
286  defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
287  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
288  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
289  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
290  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
291  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
292 #define MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
293 #endif
294 
295 /* Key exchanges in either TLS 1.2 or 1.3 which are using an ECDSA
296  * signature */
297 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
298  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
299 #define MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED
300 #endif
301 
302 #if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
303  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
304 #define MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED
305 #endif
306 
307 /* Key exchanges allowing client certificate requests.
308  *
309  * Note: that's almost the same as MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
310  * above, except RSA-PSK uses a server certificate but no client cert.
311  *
312  * Note: this difference is specific to TLS 1.2, as with TLS 1.3, things are
313  * more symmetrical: client certs and server certs are either both allowed
314  * (Ephemeral mode) or both disallowed (PSK and PKS-Ephemeral modes).
315  */
316 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
317  defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
318  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
319  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
320  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED) || \
321  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED)
322 #define MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED
323 #endif
324 
325 /* Helper to state that certificate-based client authentication through ECDSA
326  * is supported in TLS 1.2 */
327 #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) && \
328  defined(MBEDTLS_PK_CAN_ECDSA_SIGN) && defined(MBEDTLS_PK_CAN_ECDSA_VERIFY)
329 #define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED
330 #endif
331 
332 /* ECDSA required for certificates in either TLS 1.2 or 1.3 */
333 #if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED) || \
334  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
335 #define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED
336 #endif
337 
338 /* Key exchanges involving server signature in ServerKeyExchange */
339 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
340  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
341  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
342 #define MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED
343 #endif
344 
345 /* Key exchanges using ECDH */
346 #if defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
347  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
348 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED
349 #endif
350 
351 /* Key exchanges that don't involve ephemeral keys */
352 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
353  defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
354  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
355  defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED)
356 #define MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED
357 #endif
358 
359 /* Key exchanges that involve ephemeral keys */
360 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
361  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
362  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
363  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
364  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
365  defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
366 #define MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED
367 #endif
368 
369 /* Key exchanges using a PSK */
370 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
371  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
372  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
373  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
374 #define MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
375 #endif
376 
377 /* Key exchanges using DHE */
378 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
379  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
380 #define MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED
381 #endif
382 
383 /* Key exchanges using ECDHE */
384 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
385  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
386  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
387 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED
388 #endif
389 
390 /* TLS 1.2 key exchanges using ECDH or ECDHE*/
391 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED) || \
392  defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
393 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED
394 #endif
395 
396 /* TLS 1.3 PSK key exchanges */
397 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED) || \
398  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
399 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED
400 #endif
401 
402 /* TLS 1.2 or 1.3 key exchanges with PSK */
403 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) || \
404  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
405 #define MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED
406 #endif
407 
408 /* TLS 1.3 ephemeral key exchanges */
409 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) || \
410  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
411 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED
412 #endif
413 
414 /* TLS 1.3 key exchanges using ECDHE */
415 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED) && \
416  defined(PSA_WANT_ALG_ECDH)
417 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED
418 #endif
419 
420 /* TLS 1.2 or 1.3 key exchanges using ECDH or ECDHE */
421 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
422  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED)
423 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED
424 #endif
425 
426 /* TLS 1.2 XXDH key exchanges: ECDH or ECDHE or FFDH */
427 #if (defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
428  defined(MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED))
429 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_1_2_ENABLED
430 #endif
431 
432 /* The handshake params structure has a set of fields called xxdh_psa which are used:
433  * - by TLS 1.2 with `USE_PSA` to do ECDH or ECDHE;
434  * - by TLS 1.3 to do ECDHE or FFDHE.
435  * The following macros can be used to guard their declaration and use.
436  */
437 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) && \
438  defined(MBEDTLS_USE_PSA_CRYPTO)
439 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED
440 #endif
441 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED) || \
442  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
443 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED
444 #endif
445 
447 
448 #define MBEDTLS_CIPHERSUITE_WEAK 0x01
449 #define MBEDTLS_CIPHERSUITE_SHORT_TAG 0x02
451 #define MBEDTLS_CIPHERSUITE_NODTLS 0x04
462  const char *MBEDTLS_PRIVATE(name);
463 
464  uint8_t MBEDTLS_PRIVATE(cipher); /* mbedtls_cipher_type_t */
465  uint8_t MBEDTLS_PRIVATE(mac); /* mbedtls_md_type_t */
466  uint8_t MBEDTLS_PRIVATE(key_exchange); /* mbedtls_key_exchange_type_t */
467  uint8_t MBEDTLS_PRIVATE(flags);
468 
469  uint16_t MBEDTLS_PRIVATE(min_tls_version); /* mbedtls_ssl_protocol_version */
470  uint16_t MBEDTLS_PRIVATE(max_tls_version); /* mbedtls_ssl_protocol_version */
471 };
472 
474 
477 
478 #if defined(MBEDTLS_PK_C)
480 #if defined(MBEDTLS_USE_PSA_CRYPTO)
481 psa_algorithm_t mbedtls_ssl_get_ciphersuite_sig_pk_psa_alg(const mbedtls_ssl_ciphersuite_t *info);
482 psa_key_usage_t mbedtls_ssl_get_ciphersuite_sig_pk_psa_usage(const mbedtls_ssl_ciphersuite_t *info);
483 #endif
485 #endif
486 
489 
490 static inline const char *mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
491 {
492  return info->MBEDTLS_PRIVATE(name);
493 }
494 
496 
497 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED)
499 {
500  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
507  return 1;
508 
509  default:
510  return 0;
511  }
512 }
513 #endif /* MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED */
514 
515 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED)
517 {
518  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
524  return 1;
525 
526  default:
527  return 0;
528  }
529 }
530 #endif /* MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED */
531 
532 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED)
534 {
535  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
538  return 1;
539 
540  default:
541  return 0;
542  }
543 }
544 #endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED */
545 
547 {
548  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
555  return 1;
556 
557  default:
558  return 0;
559  }
560 }
561 
563 {
564  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
572  return 1;
573 
574  default:
575  return 0;
576  }
577 }
578 
579 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED)
581 {
582  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
585  return 1;
586 
587  default:
588  return 0;
589  }
590 }
591 #endif /* MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED) */
592 
593 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
595 {
596  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
600  return 1;
601 
602  default:
603  return 0;
604  }
605 }
606 #endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) */
607 
608 #if defined(MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED)
610  const mbedtls_ssl_ciphersuite_t *info)
611 {
612  switch (info->MBEDTLS_PRIVATE(key_exchange)) {
616  return 1;
617 
618  default:
619  return 0;
620  }
621 }
622 #endif /* MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED */
623 
624 #ifdef __cplusplus
625 }
626 #endif
627 
628 #endif /* ssl_ciphersuites.h */
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:139
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
Definition: crypto_types.h:328
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
Public Key abstraction layer.
mbedtls_pk_type_t
Public key types.
Definition: pk.h:85
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
int mbedtls_ssl_ciphersuite_uses_psk(const mbedtls_ssl_ciphersuite_t *info)
static int mbedtls_ssl_ciphersuite_has_pfs(const mbedtls_ssl_ciphersuite_t *info)
int mbedtls_ssl_ciphersuite_uses_ec(const mbedtls_ssl_ciphersuite_t *info)
mbedtls_pk_type_t mbedtls_ssl_get_ciphersuite_sig_alg(const mbedtls_ssl_ciphersuite_t *info)
mbedtls_pk_type_t mbedtls_ssl_get_ciphersuite_sig_pk_alg(const mbedtls_ssl_ciphersuite_t *info)
static int mbedtls_ssl_ciphersuite_no_pfs(const mbedtls_ssl_ciphersuite_t *info)
size_t mbedtls_ssl_ciphersuite_get_cipher_key_bitlen(const mbedtls_ssl_ciphersuite_t *info)
static const char * mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
static int mbedtls_ssl_ciphersuite_cert_req_allowed(const mbedtls_ssl_ciphersuite_t *info)
static int mbedtls_ssl_ciphersuite_uses_ecdhe(const mbedtls_ssl_ciphersuite_t *info)
const int * mbedtls_ssl_list_ciphersuites(void)
static int mbedtls_ssl_ciphersuite_uses_dhe(const mbedtls_ssl_ciphersuite_t *info)
static int mbedtls_ssl_ciphersuite_uses_ecdh(const mbedtls_ssl_ciphersuite_t *info)
const mbedtls_ssl_ciphersuite_t * mbedtls_ssl_ciphersuite_from_id(int ciphersuite_id)
const mbedtls_ssl_ciphersuite_t * mbedtls_ssl_ciphersuite_from_string(const char *ciphersuite_name)
static int mbedtls_ssl_ciphersuite_uses_server_signature(const mbedtls_ssl_ciphersuite_t *info)
mbedtls_key_exchange_type_t
@ MBEDTLS_KEY_EXCHANGE_PSK
@ MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA
@ MBEDTLS_KEY_EXCHANGE_DHE_PSK
@ MBEDTLS_KEY_EXCHANGE_DHE_RSA
@ MBEDTLS_KEY_EXCHANGE_ECDH_RSA
@ MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA
@ MBEDTLS_KEY_EXCHANGE_RSA
@ MBEDTLS_KEY_EXCHANGE_ECJPAKE
@ MBEDTLS_KEY_EXCHANGE_RSA_PSK
@ MBEDTLS_KEY_EXCHANGE_ECDHE_PSK
@ MBEDTLS_KEY_EXCHANGE_ECDHE_RSA
@ MBEDTLS_KEY_EXCHANGE_NONE
static int mbedtls_ssl_ciphersuite_uses_srv_cert(const mbedtls_ssl_ciphersuite_t *info)
This structure is used for storing ciphersuite information.