blob: b03123107c9d0c2b40ff7fb70dba59101f494d3c [file] [log] [blame]
Paul Bakker68884e32013-01-07 18:20:04 +01001/**
2 * \file ssl_ciphersuites.h
3 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02004 * \brief SSL Ciphersuites for Mbed TLS
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker68884e32013-01-07 18:20:04 +01009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010#ifndef MBEDTLS_SSL_CIPHERSUITES_H
11#define MBEDTLS_SSL_CIPHERSUITES_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020012#include "mbedtls/private_access.h"
Paul Bakker68884e32013-01-07 18:20:04 +010013
Bence Szépkútic662b362021-05-27 11:25:03 +020014#include "mbedtls/build_info.h"
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020015
Jaeden Amero6609aef2019-07-04 20:01:14 +010016#include "mbedtls/pk.h"
17#include "mbedtls/cipher.h"
18#include "mbedtls/md.h"
Paul Bakker68884e32013-01-07 18:20:04 +010019
20#ifdef __cplusplus
21extern "C" {
22#endif
23
Paul Bakker41c83d32013-03-20 14:39:14 +010024/*
25 * Supported ciphersuites (Official IANA names)
26 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#define MBEDTLS_TLS_PSK_WITH_NULL_SHA 0x2C /**< Weak! */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA 0x8C
30#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA 0x8D
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#define MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 0xA8 /**< TLS 1.2 */
33#define MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 0xA9 /**< TLS 1.2 */
Paul Bakker40afb4b2013-04-19 22:03:30 +020034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 0xAE
36#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 0xAF
37#define MBEDTLS_TLS_PSK_WITH_NULL_SHA256 0xB0 /**< Weak! */
38#define MBEDTLS_TLS_PSK_WITH_NULL_SHA384 0xB1 /**< Weak! */
Paul Bakker40afb4b2013-04-19 22:03:30 +020039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#define MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA 0xC001 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010041#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA 0xC004
42#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA 0xC005
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +010043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA 0xC006 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010045#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009
46#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0xC00A
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +020047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020048#define MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA 0xC00B /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010049#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA 0xC00E
50#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA 0xC00F
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +010051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052#define MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA 0xC010 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010053#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013
54#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014
Paul Bakker41c83d32013-03-20 14:39:14 +010055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023 /**< TLS 1.2 */
57#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024 /**< TLS 1.2 */
58#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 0xC025 /**< TLS 1.2 */
59#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 0xC026 /**< TLS 1.2 */
60#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027 /**< TLS 1.2 */
61#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 0xC028 /**< TLS 1.2 */
62#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 0xC029 /**< TLS 1.2 */
63#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 0xC02A /**< TLS 1.2 */
Paul Bakker0c5fac22013-04-19 21:10:51 +020064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B /**< TLS 1.2 */
66#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C /**< TLS 1.2 */
67#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 0xC02D /**< TLS 1.2 */
68#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 0xC02E /**< TLS 1.2 */
69#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F /**< TLS 1.2 */
70#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030 /**< TLS 1.2 */
71#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 0xC031 /**< TLS 1.2 */
72#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 0xC032 /**< TLS 1.2 */
Paul Bakkera54e4932013-03-20 15:31:54 +010073
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010074#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA 0xC035
75#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA 0xC036
76#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 0xC037
77#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 0xC038
78#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA 0xC039
79#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 0xC03A
80#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 0xC03B
Manuel Pégourié-Gonnard225d6aa2013-10-11 19:07:56 +020081
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +010082#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC048 /**< TLS 1.2 */
83#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC049 /**< TLS 1.2 */
84#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC04A /**< TLS 1.2 */
85#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC04B /**< TLS 1.2 */
86#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC04C /**< TLS 1.2 */
87#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC04D /**< TLS 1.2 */
88#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 0xC04E /**< TLS 1.2 */
89#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 0xC04F /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +010090#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05C /**< TLS 1.2 */
91#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05D /**< TLS 1.2 */
92#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05E /**< TLS 1.2 */
93#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05F /**< TLS 1.2 */
94#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC060 /**< TLS 1.2 */
95#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC061 /**< TLS 1.2 */
96#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 0xC062 /**< TLS 1.2 */
97#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 0xC063 /**< TLS 1.2 */
98#define MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 0xC064 /**< TLS 1.2 */
99#define MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 0xC065 /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100100#define MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 0xC06A /**< TLS 1.2 */
101#define MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 0xC06B /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100102#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC070 /**< TLS 1.2 */
103#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC071 /**< TLS 1.2 */
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000104
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100105#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC072
106#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC073
107#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC074
108#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC075
109#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC076
110#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC077
111#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC078
112#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC079
Paul Bakker27714b12013-04-07 23:07:12 +0200113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC086 /**< TLS 1.2 */
115#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC087 /**< TLS 1.2 */
116#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC088 /**< TLS 1.2 */
117#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC089 /**< TLS 1.2 */
118#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08A /**< TLS 1.2 */
119#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08B /**< TLS 1.2 */
120#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08C /**< TLS 1.2 */
121#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08D /**< TLS 1.2 */
Manuel Pégourié-Gonnard8d01eea2013-10-24 19:49:07 +0200122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC08E /**< TLS 1.2 */
124#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC08F /**< TLS 1.2 */
Manuel Pégourié-Gonnard8d01eea2013-10-24 19:49:07 +0200125
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC094
127#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC095
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100128#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC09A
129#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC09B
Paul Bakker0f2f0bf2013-07-26 15:03:31 +0200130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200131#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM 0xC0A4 /**< TLS 1.2 */
132#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM 0xC0A5 /**< TLS 1.2 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8 /**< TLS 1.2 */
134#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM_8 0xC0A9 /**< TLS 1.2 */
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200135/* The last two are named with PSK_DHE in the RFC, which looks like a typo */
136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200137#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM 0xC0AC /**< TLS 1.2 */
138#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM 0xC0AD /**< TLS 1.2 */
139#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE /**< TLS 1.2 */
140#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 0xC0AF /**< TLS 1.2 */
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200141
Manuel Pégourié-Gonnard538cb7b2015-09-15 18:03:28 +0200142#define MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 0xC0FF /**< experimental */
143
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200144/* RFC 7905 */
145#define MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8 /**< TLS 1.2 */
146#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9 /**< TLS 1.2 */
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200147#define MBEDTLS_TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAB /**< TLS 1.2 */
148#define MBEDTLS_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAC /**< TLS 1.2 */
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200149
Hanno Becker8ca26922021-07-23 19:24:23 +0100150/* RFC 8446, Appendix B.4 */
151#define MBEDTLS_TLS1_3_AES_128_GCM_SHA256 0x1301 /**< TLS 1.3 */
152#define MBEDTLS_TLS1_3_AES_256_GCM_SHA384 0x1302 /**< TLS 1.3 */
153#define MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256 0x1303 /**< TLS 1.3 */
154#define MBEDTLS_TLS1_3_AES_128_CCM_SHA256 0x1304 /**< TLS 1.3 */
155#define MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256 0x1305 /**< TLS 1.3 */
156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157/* Reminder: update mbedtls_ssl_premaster_secret when adding a new key exchange.
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100158 * Reminder: update MBEDTLS_KEY_EXCHANGE__xxx below
Manuel Pégourié-Gonnardd9423232014-12-02 11:57:29 +0100159 */
Paul Bakker68884e32013-01-07 18:20:04 +0100160typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200161 MBEDTLS_KEY_EXCHANGE_NONE = 0,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162 MBEDTLS_KEY_EXCHANGE_ECDHE_RSA,
163 MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA,
164 MBEDTLS_KEY_EXCHANGE_PSK,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165 MBEDTLS_KEY_EXCHANGE_ECDHE_PSK,
166 MBEDTLS_KEY_EXCHANGE_ECDH_RSA,
167 MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA,
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200168 MBEDTLS_KEY_EXCHANGE_ECJPAKE,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169} mbedtls_key_exchange_type_t;
Paul Bakker68884e32013-01-07 18:20:04 +0100170
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200171/* Key exchanges using a certificate */
Gabor Mezeie1e27302025-02-26 18:06:05 +0100172#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100173 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100174 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100176#define MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
Manuel Pégourié-Gonnardd9423232014-12-02 11:57:29 +0100177#endif
178
Valerio Settic8ccc8f2023-08-02 20:00:13 +0200179/* Key exchanges in either TLS 1.2 or 1.3 which are using an ECDSA
180 * signature */
Valerio Setti2430a702023-07-13 17:22:51 +0200181#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
182 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
183#define MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED
184#endif
185
Ronald Crone68ab4f2022-10-05 12:46:29 +0200186#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
187 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
188#define MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED
189#endif
190
Manuel Pégourié-Gonnard97bb7262023-09-18 11:28:32 +0200191/* Key exchanges allowing client certificate requests.
192 *
Gilles Peskine0068fce2024-09-20 18:39:29 +0200193 * This is now the same as MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED,
194 * and the two macros could be unified.
195 * Until Mbed TLS 3.x, the two sets were different because
196 * MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED covers
197 * MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED plus RSA-PSK.
198 * But RSA-PSK was removed in Mbed TLS 4.0.
Manuel Pégourié-Gonnard97bb7262023-09-18 11:28:32 +0200199 */
Gilles Peskine0068fce2024-09-20 18:39:29 +0200200#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100201#define MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100202#endif
203
Valerio Setti568799f2023-08-18 16:27:00 +0200204/* Helper to state that certificate-based client authentication through ECDSA
Valerio Setti2430a702023-07-13 17:22:51 +0200205 * is supported in TLS 1.2 */
206#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) && \
Elena Uziunaitebed21b52024-08-27 11:56:25 +0100207 defined(PSA_HAVE_ALG_ECDSA_SIGN) && defined(PSA_HAVE_ALG_ECDSA_VERIFY)
Valerio Setti2430a702023-07-13 17:22:51 +0200208#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED
209#endif
210
Valerio Settic8ccc8f2023-08-02 20:00:13 +0200211/* ECDSA required for certificates in either TLS 1.2 or 1.3 */
212#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED) || \
213 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
214#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED
215#endif
216
Hanno Becker1aa267c2017-04-28 17:08:27 +0100217/* Key exchanges involving server signature in ServerKeyExchange */
Valerio Settib8621b62025-01-22 11:42:34 +0100218#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Hanno Becker1aa267c2017-04-28 17:08:27 +0100219 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100220#define MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100221#endif
222
223/* Key exchanges using ECDH */
224#if defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
225 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100226#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100227#endif
228
229/* Key exchanges that don't involve ephemeral keys */
Gabor Mezeie1e27302025-02-26 18:06:05 +0100230#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100231 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED)
232#define MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100233#endif
234
235/* Key exchanges that involve ephemeral keys */
Valerio Settib8621b62025-01-22 11:42:34 +0100236#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Hanno Becker1aa267c2017-04-28 17:08:27 +0100237 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
238 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
239 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100240#define MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100241#endif
242
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200243/* Key exchanges using a PSK */
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100244#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100245 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100246#define MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100247#endif
248
Hanno Becker1aa267c2017-04-28 17:08:27 +0100249/* Key exchanges using ECDHE */
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100250#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
251 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
252 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100253#define MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100254#endif
255
Valerio Settied365e62023-07-07 15:02:27 +0200256/* TLS 1.2 key exchanges using ECDH or ECDHE*/
Valerio Setti00dc4062023-07-05 18:48:43 +0200257#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED) || \
258 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
259#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED
260#endif
261
Valerio Setti0a0d0d52023-07-07 15:12:45 +0200262/* TLS 1.3 PSK key exchanges */
263#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED) || \
264 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
265#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED
266#endif
267
268/* TLS 1.2 or 1.3 key exchanges with PSK */
269#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) || \
270 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
271#define MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED
272#endif
273
274/* TLS 1.3 ephemeral key exchanges */
275#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) || \
276 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
277#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED
278#endif
279
Valerio Settiea59c432023-07-25 11:14:03 +0200280/* TLS 1.3 key exchanges using ECDHE */
Valerio Settied365e62023-07-07 15:02:27 +0200281#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED) && \
282 defined(PSA_WANT_ALG_ECDH)
283#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED
284#endif
285
286/* TLS 1.2 or 1.3 key exchanges using ECDH or ECDHE */
Valerio Setti00dc4062023-07-05 18:48:43 +0200287#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
Valerio Settied365e62023-07-07 15:02:27 +0200288 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED)
Valerio Settie87915b2023-07-06 12:47:43 +0200289#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED
290#endif
291
Valerio Setti9cd80112023-07-25 12:04:21 +0200292/* The handshake params structure has a set of fields called xxdh_psa which are used:
Janos Follath130ece02024-11-19 16:16:36 +0000293 * - by TLS 1.2 to do ECDH or ECDHE;
Valerio Setti9cd80112023-07-25 12:04:21 +0200294 * - by TLS 1.3 to do ECDHE or FFDHE.
295 * The following macros can be used to guard their declaration and use.
296 */
Manuel Pégourié-Gonnard87381612025-01-22 12:55:54 +0100297#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Valerio Setti9cd80112023-07-25 12:04:21 +0200298#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED
299#endif
300#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED) || \
Valerio Setti3d237b52023-07-07 16:00:20 +0200301 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Valerio Settiea59c432023-07-25 11:14:03 +0200302#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED
Valerio Setti3d237b52023-07-07 16:00:20 +0200303#endif
304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305typedef struct mbedtls_ssl_ciphersuite_t mbedtls_ssl_ciphersuite_t;
Paul Bakker68884e32013-01-07 18:20:04 +0100306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307#define MBEDTLS_CIPHERSUITE_WEAK 0x01 /**< Weak ciphersuite flag */
308#define MBEDTLS_CIPHERSUITE_SHORT_TAG 0x02 /**< Short authentication tag,
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200309 eg for CCM_8 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310#define MBEDTLS_CIPHERSUITE_NODTLS 0x04 /**< Can't be used with DTLS */
Paul Bakker68884e32013-01-07 18:20:04 +0100311
312/**
313 * \brief This structure is used for storing ciphersuite information
Glenn Strauss60bfe602022-03-14 19:04:24 -0400314 *
315 * \note members are defined using integral types instead of enums
316 * in order to pack structure and reduce memory usage by internal
317 * \c ciphersuite_definitions[]
Paul Bakker68884e32013-01-07 18:20:04 +0100318 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100319struct mbedtls_ssl_ciphersuite_t {
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200320 int MBEDTLS_PRIVATE(id);
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 const char *MBEDTLS_PRIVATE(name);
Paul Bakker68884e32013-01-07 18:20:04 +0100322
Glenn Strauss60bfe602022-03-14 19:04:24 -0400323 uint8_t MBEDTLS_PRIVATE(cipher); /* mbedtls_cipher_type_t */
324 uint8_t MBEDTLS_PRIVATE(mac); /* mbedtls_md_type_t */
325 uint8_t MBEDTLS_PRIVATE(key_exchange); /* mbedtls_key_exchange_type_t */
326 uint8_t MBEDTLS_PRIVATE(flags);
Paul Bakker68884e32013-01-07 18:20:04 +0100327
Glenn Strauss60bfe602022-03-14 19:04:24 -0400328 uint16_t MBEDTLS_PRIVATE(min_tls_version); /* mbedtls_ssl_protocol_version */
329 uint16_t MBEDTLS_PRIVATE(max_tls_version); /* mbedtls_ssl_protocol_version */
Paul Bakker68884e32013-01-07 18:20:04 +0100330};
331
Gilles Peskine449bd832023-01-11 14:50:10 +0100332const int *mbedtls_ssl_list_ciphersuites(void);
Paul Bakker68884e32013-01-07 18:20:04 +0100333
Gilles Peskine449bd832023-01-11 14:50:10 +0100334const mbedtls_ssl_ciphersuite_t *mbedtls_ssl_ciphersuite_from_string(const char *ciphersuite_name);
335const mbedtls_ssl_ciphersuite_t *mbedtls_ssl_ciphersuite_from_id(int ciphersuite_id);
Paul Bakker68884e32013-01-07 18:20:04 +0100336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static inline const char *mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
Glenn Strauss8f526902022-01-13 00:04:49 -0500338{
339 return info->MBEDTLS_PRIVATE(name);
340}
341
Minos Galanakis40d47082024-03-04 15:24:51 +0000342static inline int mbedtls_ssl_ciphersuite_get_id(const mbedtls_ssl_ciphersuite_t *info)
Minos Galanakis358b4482024-03-04 02:19:31 +0000343{
344 return info->MBEDTLS_PRIVATE(id);
345}
346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347size_t mbedtls_ssl_ciphersuite_get_cipher_key_bitlen(const mbedtls_ssl_ciphersuite_t *info);
Glenn Strauss8f526902022-01-13 00:04:49 -0500348
Paul Bakker68884e32013-01-07 18:20:04 +0100349#ifdef __cplusplus
350}
351#endif
352
353#endif /* ssl_ciphersuites.h */