Mbed TLS v3.6.1
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 OR GPL-2.0-or-later
9  */
10 #ifndef MBEDTLS_SSL_CIPHERSUITES_H
11 #define MBEDTLS_SSL_CIPHERSUITES_H
12 #include "mbedtls/private_access.h"
13 
14 #include "mbedtls/build_info.h"
15 
16 #include "mbedtls/pk.h"
17 #include "mbedtls/cipher.h"
18 #include "mbedtls/md.h"
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 /*
25  * Supported ciphersuites (Official IANA names)
26  */
27 #define MBEDTLS_TLS_RSA_WITH_NULL_MD5 0x01
28 #define MBEDTLS_TLS_RSA_WITH_NULL_SHA 0x02
30 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA 0x2C
31 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA 0x2D
32 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA 0x2E
33 #define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA 0x2F
34 
35 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA 0x33
36 #define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA 0x35
37 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA 0x39
38 
39 #define MBEDTLS_TLS_RSA_WITH_NULL_SHA256 0x3B
40 #define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 0x3C
41 #define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 0x3D
43 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA 0x41
44 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA 0x45
45 
46 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 0x67
47 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 0x6B
49 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA 0x84
50 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA 0x88
51 
52 #define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA 0x8C
53 #define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA 0x8D
54 
55 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA 0x90
56 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA 0x91
57 
58 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA 0x94
59 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA 0x95
60 
61 #define MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 0x9C
62 #define MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 0x9D
63 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 0x9E
64 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 0x9F
66 #define MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 0xA8
67 #define MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 0xA9
68 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 0xAA
69 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 0xAB
70 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 0xAC
71 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 0xAD
73 #define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 0xAE
74 #define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 0xAF
75 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA256 0xB0
76 #define MBEDTLS_TLS_PSK_WITH_NULL_SHA384 0xB1
78 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 0xB2
79 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 0xB3
80 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256 0xB4
81 #define MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384 0xB5
83 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 0xB6
84 #define MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 0xB7
85 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256 0xB8
86 #define MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384 0xB9
88 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBA
89 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBE
91 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC0
92 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC4
94 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA 0xC001
95 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA 0xC004
96 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA 0xC005
97 
98 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA 0xC006
99 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009
100 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0xC00A
101 
102 #define MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA 0xC00B
103 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA 0xC00E
104 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA 0xC00F
105 
106 #define MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA 0xC010
107 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013
108 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014
109 
110 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023
111 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024
112 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 0xC025
113 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 0xC026
114 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027
115 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 0xC028
116 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 0xC029
117 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 0xC02A
119 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B
120 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C
121 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 0xC02D
122 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 0xC02E
123 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F
124 #define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030
125 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 0xC031
126 #define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 0xC032
128 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA 0xC035
129 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA 0xC036
130 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 0xC037
131 #define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 0xC038
132 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA 0xC039
133 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 0xC03A
134 #define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 0xC03B
135 
136 #define MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256 0xC03C
137 #define MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384 0xC03D
138 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC044
139 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC045
140 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC048
141 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC049
142 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC04A
143 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC04B
144 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC04C
145 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC04D
146 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 0xC04E
147 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 0xC04F
148 #define MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256 0xC050
149 #define MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384 0xC051
150 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC052
151 #define MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC053
152 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05C
153 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05D
154 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05E
155 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05F
156 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC060
157 #define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC061
158 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 0xC062
159 #define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 0xC063
160 #define MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 0xC064
161 #define MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 0xC065
162 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC066
163 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC067
164 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 0xC068
165 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 0xC069
166 #define MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 0xC06A
167 #define MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 0xC06B
168 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 0xC06C
169 #define MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 0xC06D
170 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 0xC06E
171 #define MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 0xC06F
172 #define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC070
173 #define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC071
175 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC072
176 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC073
177 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC074
178 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC075
179 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC076
180 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC077
181 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC078
182 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC079
183 
184 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC07A
185 #define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC07B
186 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC07C
187 #define MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC07D
188 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC086
189 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC087
190 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC088
191 #define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC089
192 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08A
193 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08B
194 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08C
195 #define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08D
197 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC08E
198 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC08F
199 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC090
200 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC091
201 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC092
202 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC093
204 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC094
205 #define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC095
206 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC096
207 #define MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC097
208 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC098
209 #define MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC099
210 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC09A
211 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC09B
212 
213 #define MBEDTLS_TLS_RSA_WITH_AES_128_CCM 0xC09C
214 #define MBEDTLS_TLS_RSA_WITH_AES_256_CCM 0xC09D
215 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CCM 0xC09E
216 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CCM 0xC09F
217 #define MBEDTLS_TLS_RSA_WITH_AES_128_CCM_8 0xC0A0
218 #define MBEDTLS_TLS_RSA_WITH_AES_256_CCM_8 0xC0A1
219 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CCM_8 0xC0A2
220 #define MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CCM_8 0xC0A3
221 #define MBEDTLS_TLS_PSK_WITH_AES_128_CCM 0xC0A4
222 #define MBEDTLS_TLS_PSK_WITH_AES_256_CCM 0xC0A5
223 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CCM 0xC0A6
224 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CCM 0xC0A7
225 #define MBEDTLS_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8
226 #define MBEDTLS_TLS_PSK_WITH_AES_256_CCM_8 0xC0A9
227 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CCM_8 0xC0AA
228 #define MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CCM_8 0xC0AB
229 /* The last two are named with PSK_DHE in the RFC, which looks like a typo */
230 
231 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM 0xC0AC
232 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM 0xC0AD
233 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
234 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 0xC0AF
236 #define MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 0xC0FF
238 /* RFC 7905 */
239 #define MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8
240 #define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9
241 #define MBEDTLS_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCAA
242 #define MBEDTLS_TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAB
243 #define MBEDTLS_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAC
244 #define MBEDTLS_TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAD
245 #define MBEDTLS_TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAE
247 /* RFC 8446, Appendix B.4 */
248 #define MBEDTLS_TLS1_3_AES_128_GCM_SHA256 0x1301
249 #define MBEDTLS_TLS1_3_AES_256_GCM_SHA384 0x1302
250 #define MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256 0x1303
251 #define MBEDTLS_TLS1_3_AES_128_CCM_SHA256 0x1304
252 #define MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256 0x1305
254 /* Reminder: update mbedtls_ssl_premaster_secret when adding a new key exchange.
255  * Reminder: update MBEDTLS_KEY_EXCHANGE__xxx below
256  */
257 typedef enum {
271 
272 /* Key exchanges using a certificate */
273 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
274  defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
275  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
276  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
277  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
278  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
279  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
280 #define MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
281 #endif
282 
283 /* Key exchanges in either TLS 1.2 or 1.3 which are using an ECDSA
284  * signature */
285 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
286  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
287 #define MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED
288 #endif
289 
290 #if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
291  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
292 #define MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED
293 #endif
294 
295 /* Key exchanges allowing client certificate requests.
296  *
297  * Note: that's almost the same as MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
298  * above, except RSA-PSK uses a server certificate but no client cert.
299  *
300  * Note: this difference is specific to TLS 1.2, as with TLS 1.3, things are
301  * more symmetrical: client certs and server certs are either both allowed
302  * (Ephemeral mode) or both disallowed (PSK and PKS-Ephemeral modes).
303  */
304 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
305  defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
306  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
307  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
308  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED) || \
309  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED)
310 #define MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED
311 #endif
312 
313 /* Helper to state that certificate-based client authentication through ECDSA
314  * is supported in TLS 1.2 */
315 #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) && \
316  defined(MBEDTLS_PK_CAN_ECDSA_SIGN) && defined(MBEDTLS_PK_CAN_ECDSA_VERIFY)
317 #define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED
318 #endif
319 
320 /* ECDSA required for certificates in either TLS 1.2 or 1.3 */
321 #if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED) || \
322  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
323 #define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED
324 #endif
325 
326 /* Key exchanges involving server signature in ServerKeyExchange */
327 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
328  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
329  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
330 #define MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED
331 #endif
332 
333 /* Key exchanges using ECDH */
334 #if defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
335  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
336 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED
337 #endif
338 
339 /* Key exchanges that don't involve ephemeral keys */
340 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
341  defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
342  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
343  defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED)
344 #define MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED
345 #endif
346 
347 /* Key exchanges that involve ephemeral keys */
348 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
349  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
350  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
351  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
352  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
353  defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
354 #define MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED
355 #endif
356 
357 /* Key exchanges using a PSK */
358 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
359  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
360  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
361  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
362 #define MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
363 #endif
364 
365 /* Key exchanges using DHE */
366 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
367  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
368 #define MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED
369 #endif
370 
371 /* Key exchanges using ECDHE */
372 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
373  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
374  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
375 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED
376 #endif
377 
378 /* TLS 1.2 key exchanges using ECDH or ECDHE*/
379 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED) || \
380  defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
381 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED
382 #endif
383 
384 /* TLS 1.3 PSK key exchanges */
385 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED) || \
386  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
387 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED
388 #endif
389 
390 /* TLS 1.2 or 1.3 key exchanges with PSK */
391 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) || \
392  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
393 #define MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED
394 #endif
395 
396 /* TLS 1.3 ephemeral key exchanges */
397 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) || \
398  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
399 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED
400 #endif
401 
402 /* TLS 1.3 key exchanges using ECDHE */
403 #if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED) && \
404  defined(PSA_WANT_ALG_ECDH)
405 #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED
406 #endif
407 
408 /* TLS 1.2 or 1.3 key exchanges using ECDH or ECDHE */
409 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
410  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED)
411 #define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED
412 #endif
413 
414 /* TLS 1.2 XXDH key exchanges: ECDH or ECDHE or FFDH */
415 #if (defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
416  defined(MBEDTLS_KEY_EXCHANGE_SOME_DHE_ENABLED))
417 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_1_2_ENABLED
418 #endif
419 
420 /* The handshake params structure has a set of fields called xxdh_psa which are used:
421  * - by TLS 1.2 with `USE_PSA` to do ECDH or ECDHE;
422  * - by TLS 1.3 to do ECDHE or FFDHE.
423  * The following macros can be used to guard their declaration and use.
424  */
425 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) && \
426  defined(MBEDTLS_USE_PSA_CRYPTO)
427 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED
428 #endif
429 #if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED) || \
430  defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
431 #define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED
432 #endif
433 
435 
436 #define MBEDTLS_CIPHERSUITE_WEAK 0x01
437 #define MBEDTLS_CIPHERSUITE_SHORT_TAG 0x02
439 #define MBEDTLS_CIPHERSUITE_NODTLS 0x04
450  const char *MBEDTLS_PRIVATE(name);
451 
452  uint8_t MBEDTLS_PRIVATE(cipher); /* mbedtls_cipher_type_t */
453  uint8_t MBEDTLS_PRIVATE(mac); /* mbedtls_md_type_t */
454  uint8_t MBEDTLS_PRIVATE(key_exchange); /* mbedtls_key_exchange_type_t */
455  uint8_t MBEDTLS_PRIVATE(flags);
456 
457  uint16_t MBEDTLS_PRIVATE(min_tls_version); /* mbedtls_ssl_protocol_version */
458  uint16_t MBEDTLS_PRIVATE(max_tls_version); /* mbedtls_ssl_protocol_version */
459 };
460 
462 
465 
466 static inline const char *mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
467 {
468  return info->MBEDTLS_PRIVATE(name);
469 }
470 
472 {
473  return info->MBEDTLS_PRIVATE(id);
474 }
475 
477 
478 #ifdef __cplusplus
479 }
480 #endif
481 
482 #endif /* ssl_ciphersuites.h */
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
Public Key abstraction layer.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
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)
const int * mbedtls_ssl_list_ciphersuites(void)
static int mbedtls_ssl_ciphersuite_get_id(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)
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
This structure is used for storing ciphersuite information.