Mbed TLS v4.1.1
Toggle main menu visibility
Loading...
Searching...
No Matches
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/md.h
"
18
19
#ifdef __cplusplus
20
extern
"C"
{
21
#endif
22
23
/*
24
* Supported ciphersuites (Official IANA names)
25
*/
26
#define MBEDTLS_TLS_PSK_WITH_NULL_SHA 0x2C
27
28
#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA 0x8C
29
#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA 0x8D
30
31
#define MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 0xA8
32
#define MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 0xA9
33
34
#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 0xAE
35
#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 0xAF
36
#define MBEDTLS_TLS_PSK_WITH_NULL_SHA256 0xB0
37
#define MBEDTLS_TLS_PSK_WITH_NULL_SHA384 0xB1
38
39
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA 0xC006
40
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009
41
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0xC00A
42
43
#define MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA 0xC010
44
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013
45
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014
46
47
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023
48
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024
49
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027
50
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 0xC028
51
52
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B
53
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C
54
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F
55
#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030
56
57
#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA 0xC035
58
#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA 0xC036
59
#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 0xC037
60
#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 0xC038
61
#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA 0xC039
62
#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 0xC03A
63
#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 0xC03B
64
65
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC048
66
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC049
67
#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC04C
68
#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC04D
69
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05C
70
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05D
71
#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC060
72
#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC061
73
#define MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 0xC064
74
#define MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 0xC065
75
#define MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 0xC06A
76
#define MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 0xC06B
77
#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC070
78
#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC071
79
80
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC072
81
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC073
82
#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC076
83
#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC077
84
85
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC086
86
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC087
87
#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08A
88
#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08B
89
90
#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC08E
91
#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC08F
92
93
#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC094
94
#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC095
95
#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC09A
96
#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC09B
97
98
#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM 0xC0A4
99
#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM 0xC0A5
100
#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8
101
#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM_8 0xC0A9
102
/* The last two are named with PSK_DHE in the RFC, which looks like a typo */
103
104
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM 0xC0AC
105
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM 0xC0AD
106
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
107
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 0xC0AF
108
109
#define MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 0xC0FF
110
111
/* RFC 7905 */
112
#define MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8
113
#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9
114
#define MBEDTLS_TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAB
115
#define MBEDTLS_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAC
116
117
/* RFC 8446, Appendix B.4 */
118
#define MBEDTLS_TLS1_3_AES_128_GCM_SHA256 0x1301
119
#define MBEDTLS_TLS1_3_AES_256_GCM_SHA384 0x1302
120
#define MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256 0x1303
121
#define MBEDTLS_TLS1_3_AES_128_CCM_SHA256 0x1304
122
#define MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256 0x1305
123
124
/* Reminder: update mbedtls_ssl_premaster_secret when adding a new key exchange.
125
* Reminder: update MBEDTLS_KEY_EXCHANGE__xxx below
126
*/
127
typedef
enum
{
128
MBEDTLS_KEY_EXCHANGE_NONE
= 0,
129
MBEDTLS_KEY_EXCHANGE_ECDHE_RSA
,
130
MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA
,
131
MBEDTLS_KEY_EXCHANGE_PSK
,
132
MBEDTLS_KEY_EXCHANGE_ECDHE_PSK
,
133
MBEDTLS_KEY_EXCHANGE_ECJPAKE
,
134
}
mbedtls_key_exchange_type_t
;
135
136
/* Key exchanges using a certificate */
137
#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
138
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
139
#define MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
140
#endif
141
142
/* Key exchanges in either TLS 1.2 or 1.3 which are using an ECDSA
143
* signature */
144
#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
145
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
146
#define MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED
147
#endif
148
149
#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
150
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
151
#define MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED
152
#endif
153
154
/* Key exchanges allowing client certificate requests.
155
*
156
* This is now the same as MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED,
157
* and the two macros could be unified.
158
* Until Mbed TLS 3.x, the two sets were different because
159
* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED covers
160
* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED plus RSA-PSK.
161
* But RSA-PSK was removed in Mbed TLS 4.0.
162
*/
163
#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
164
#define MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED
165
#endif
166
167
/* Helper to state that certificate-based client authentication through ECDSA
168
* is supported in TLS 1.2 */
169
#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) && \
170
defined(PSA_HAVE_ALG_ECDSA_SIGN) && defined(PSA_HAVE_ALG_ECDSA_VERIFY)
171
#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED
172
#endif
173
174
/* ECDSA required for certificates in either TLS 1.2 or 1.3 */
175
#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED) || \
176
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
177
#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED
178
#endif
179
180
/* Key exchanges involving server signature in ServerKeyExchange */
181
#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
182
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
183
#define MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED
184
#endif
185
186
/* Key exchanges that involve ephemeral keys */
187
#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
188
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
189
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
190
defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
191
#define MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED
192
#endif
193
194
/* Key exchanges using a PSK */
195
#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
196
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
197
#define MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
198
#endif
199
200
/* Key exchanges using ECDHE */
201
#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
202
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
203
defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
204
#define MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED
205
#endif
206
207
/* TLS 1.2 key exchanges using ECDH or ECDHE*/
208
#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
209
#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED
210
#endif
211
212
/* TLS 1.3 PSK key exchanges */
213
#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED) || \
214
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
215
#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED
216
#endif
217
218
/* TLS 1.2 or 1.3 key exchanges with PSK */
219
#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) || \
220
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
221
#define MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED
222
#endif
223
224
/* TLS 1.3 ephemeral key exchanges */
225
#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) || \
226
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
227
#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED
228
#endif
229
230
/* TLS 1.3 key exchanges using ECDHE */
231
#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED) && \
232
defined(PSA_WANT_ALG_ECDH)
233
#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED
234
#endif
235
236
/* TLS 1.2 or 1.3 key exchanges using ECDH or ECDHE */
237
#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
238
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED)
239
#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED
240
#endif
241
242
/* The handshake params structure has a set of fields called xxdh_psa which are used:
243
* - by TLS 1.2 to do ECDH or ECDHE;
244
* - by TLS 1.3 to do ECDHE or FFDHE.
245
* The following macros can be used to guard their declaration and use.
246
*/
247
#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
248
#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED
249
#endif
250
#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED) || \
251
defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
252
#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED
253
#endif
254
255
typedef
struct
mbedtls_ssl_ciphersuite_t
mbedtls_ssl_ciphersuite_t
;
256
257
#define MBEDTLS_CIPHERSUITE_WEAK 0x01
258
#define MBEDTLS_CIPHERSUITE_SHORT_TAG 0x02
260
#define MBEDTLS_CIPHERSUITE_NODTLS 0x04
261
269
struct
mbedtls_ssl_ciphersuite_t
{
270
int
MBEDTLS_PRIVATE(
id
);
271
const
char
*MBEDTLS_PRIVATE(name);
272
273
uint8_t MBEDTLS_PRIVATE(cipher);
/* mbedtls_cipher_type_t */
274
uint8_t MBEDTLS_PRIVATE(mac);
/* mbedtls_md_type_t */
275
uint8_t MBEDTLS_PRIVATE(key_exchange);
/* mbedtls_key_exchange_type_t */
276
uint8_t MBEDTLS_PRIVATE(flags);
277
278
uint16_t MBEDTLS_PRIVATE(min_tls_version);
/* mbedtls_ssl_protocol_version */
279
uint16_t MBEDTLS_PRIVATE(max_tls_version);
/* mbedtls_ssl_protocol_version */
280
};
281
282
const
int
*
mbedtls_ssl_list_ciphersuites
(
void
);
283
284
const
mbedtls_ssl_ciphersuite_t
*
mbedtls_ssl_ciphersuite_from_string
(
const
char
*ciphersuite_name);
285
const
mbedtls_ssl_ciphersuite_t
*
mbedtls_ssl_ciphersuite_from_id
(
int
ciphersuite_id);
286
287
static
inline
const
char
*
mbedtls_ssl_ciphersuite_get_name
(
const
mbedtls_ssl_ciphersuite_t
*info)
288
{
289
return
info->MBEDTLS_PRIVATE(name);
290
}
291
292
static
inline
int
mbedtls_ssl_ciphersuite_get_id
(
const
mbedtls_ssl_ciphersuite_t
*info)
293
{
294
return
info->MBEDTLS_PRIVATE(
id
);
295
}
296
297
size_t
mbedtls_ssl_ciphersuite_get_cipher_key_bitlen
(
const
mbedtls_ssl_ciphersuite_t
*info);
298
299
#ifdef __cplusplus
300
}
301
#endif
302
303
#endif
/* ssl_ciphersuites.h */
build_info.h
Build-time configuration info.
md.h
This file contains the generic functions for message-digest (hashing) and HMAC.
pk.h
Public Key abstraction layer.
mbedtls_ssl_list_ciphersuites
const int * mbedtls_ssl_list_ciphersuites(void)
mbedtls_ssl_ciphersuite_from_id
const mbedtls_ssl_ciphersuite_t * mbedtls_ssl_ciphersuite_from_id(int ciphersuite_id)
mbedtls_ssl_ciphersuite_get_cipher_key_bitlen
size_t mbedtls_ssl_ciphersuite_get_cipher_key_bitlen(const mbedtls_ssl_ciphersuite_t *info)
mbedtls_ssl_ciphersuite_from_string
const mbedtls_ssl_ciphersuite_t * mbedtls_ssl_ciphersuite_from_string(const char *ciphersuite_name)
mbedtls_ssl_ciphersuite_get_name
static const char * mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
Definition
ssl_ciphersuites.h:287
mbedtls_ssl_ciphersuite_get_id
static int mbedtls_ssl_ciphersuite_get_id(const mbedtls_ssl_ciphersuite_t *info)
Definition
ssl_ciphersuites.h:292
mbedtls_key_exchange_type_t
mbedtls_key_exchange_type_t
Definition
ssl_ciphersuites.h:127
MBEDTLS_KEY_EXCHANGE_PSK
@ MBEDTLS_KEY_EXCHANGE_PSK
Definition
ssl_ciphersuites.h:131
MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA
@ MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA
Definition
ssl_ciphersuites.h:130
MBEDTLS_KEY_EXCHANGE_ECJPAKE
@ MBEDTLS_KEY_EXCHANGE_ECJPAKE
Definition
ssl_ciphersuites.h:133
MBEDTLS_KEY_EXCHANGE_ECDHE_PSK
@ MBEDTLS_KEY_EXCHANGE_ECDHE_PSK
Definition
ssl_ciphersuites.h:132
MBEDTLS_KEY_EXCHANGE_ECDHE_RSA
@ MBEDTLS_KEY_EXCHANGE_ECDHE_RSA
Definition
ssl_ciphersuites.h:129
MBEDTLS_KEY_EXCHANGE_NONE
@ MBEDTLS_KEY_EXCHANGE_NONE
Definition
ssl_ciphersuites.h:128
mbedtls_ssl_ciphersuite_t
This structure is used for storing ciphersuite information.
Definition
ssl_ciphersuites.h:269
include
mbedtls
ssl_ciphersuites.h
Generated on
for Mbed TLS v4.1.1 by
1.17.0