blob: 5d5b4b94b87eb9b7a3767c36c20ab0e9ae5d6322 [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_RSA_WITH_NULL_MD5 0x01 /**< Weak! */
28#define MBEDTLS_TLS_RSA_WITH_NULL_SHA 0x02 /**< Weak! */
Paul Bakker41c83d32013-03-20 14:39:14 +010029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#define MBEDTLS_TLS_PSK_WITH_NULL_SHA 0x2C /**< Weak! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA 0x2F
Paul Bakker0c5fac22013-04-19 21:10:51 +020032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA 0x35
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#define MBEDTLS_TLS_RSA_WITH_NULL_SHA256 0x3B /**< Weak! */
36#define MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 0x3C /**< TLS 1.2 */
37#define MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 0x3D /**< TLS 1.2 */
Paul Bakker41c83d32013-03-20 14:39:14 +010038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA 0x41
Paul Bakker0c5fac22013-04-19 21:10:51 +020040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA 0x84
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA 0x8C
44#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA 0x8D
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020046#define MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 0x9C /**< TLS 1.2 */
47#define MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 0x9D /**< TLS 1.2 */
Paul Bakker41c83d32013-03-20 14:39:14 +010048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#define MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 0xA8 /**< TLS 1.2 */
50#define MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 0xA9 /**< TLS 1.2 */
Paul Bakker40afb4b2013-04-19 22:03:30 +020051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052#define MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 0xAE
53#define MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 0xAF
54#define MBEDTLS_TLS_PSK_WITH_NULL_SHA256 0xB0 /**< Weak! */
55#define MBEDTLS_TLS_PSK_WITH_NULL_SHA384 0xB1 /**< Weak! */
Paul Bakker40afb4b2013-04-19 22:03:30 +020056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020057#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBA /**< TLS 1.2 */
Paul Bakker0c5fac22013-04-19 21:10:51 +020058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC0 /**< TLS 1.2 */
Paul Bakker0c5fac22013-04-19 21:10:51 +020060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#define MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA 0xC001 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010062#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA 0xC004
63#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA 0xC005
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +010064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA 0xC006 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010066#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009
67#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0xC00A
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +020068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020069#define MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA 0xC00B /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010070#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA 0xC00E
71#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA 0xC00F
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +010072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073#define MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA 0xC010 /**< Weak! */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010074#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013
75#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014
Paul Bakker41c83d32013-03-20 14:39:14 +010076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023 /**< TLS 1.2 */
78#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024 /**< TLS 1.2 */
79#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 0xC025 /**< TLS 1.2 */
80#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 0xC026 /**< TLS 1.2 */
81#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027 /**< TLS 1.2 */
82#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 0xC028 /**< TLS 1.2 */
83#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 0xC029 /**< TLS 1.2 */
84#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 0xC02A /**< TLS 1.2 */
Paul Bakker0c5fac22013-04-19 21:10:51 +020085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B /**< TLS 1.2 */
87#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C /**< TLS 1.2 */
88#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 0xC02D /**< TLS 1.2 */
89#define MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 0xC02E /**< TLS 1.2 */
90#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F /**< TLS 1.2 */
91#define MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030 /**< TLS 1.2 */
92#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 0xC031 /**< TLS 1.2 */
93#define MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 0xC032 /**< TLS 1.2 */
Paul Bakkera54e4932013-03-20 15:31:54 +010094
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +010095#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA 0xC035
96#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA 0xC036
97#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 0xC037
98#define MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 0xC038
99#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA 0xC039
100#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 0xC03A
101#define MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 0xC03B
Manuel Pégourié-Gonnard225d6aa2013-10-11 19:07:56 +0200102
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100103#define MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256 0xC03C /**< TLS 1.2 */
104#define MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384 0xC03D /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100105#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC048 /**< TLS 1.2 */
106#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC049 /**< TLS 1.2 */
107#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 0xC04A /**< TLS 1.2 */
108#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 0xC04B /**< TLS 1.2 */
109#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 0xC04C /**< TLS 1.2 */
110#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 0xC04D /**< TLS 1.2 */
111#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 0xC04E /**< TLS 1.2 */
112#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 0xC04F /**< TLS 1.2 */
113#define MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256 0xC050 /**< TLS 1.2 */
114#define MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384 0xC051 /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100115#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05C /**< TLS 1.2 */
116#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05D /**< TLS 1.2 */
117#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 0xC05E /**< TLS 1.2 */
118#define MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 0xC05F /**< TLS 1.2 */
119#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 0xC060 /**< TLS 1.2 */
120#define MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 0xC061 /**< TLS 1.2 */
121#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 0xC062 /**< TLS 1.2 */
122#define MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 0xC063 /**< TLS 1.2 */
123#define MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 0xC064 /**< TLS 1.2 */
124#define MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 0xC065 /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100125#define MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 0xC06A /**< TLS 1.2 */
126#define MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 0xC06B /**< TLS 1.2 */
Manuel Pégourié-Gonnard4231e7f2018-02-28 10:54:31 +0100127#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 0xC070 /**< TLS 1.2 */
128#define MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 0xC071 /**< TLS 1.2 */
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000129
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100130#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC072
131#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC073
132#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 0xC074
133#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 0xC075
134#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC076
135#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC077
136#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xC078
137#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 0xC079
Paul Bakker27714b12013-04-07 23:07:12 +0200138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC07A /**< TLS 1.2 */
140#define MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC07B /**< TLS 1.2 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC086 /**< TLS 1.2 */
142#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC087 /**< TLS 1.2 */
143#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 0xC088 /**< TLS 1.2 */
144#define MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 0xC089 /**< TLS 1.2 */
145#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08A /**< TLS 1.2 */
146#define MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08B /**< TLS 1.2 */
147#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 0xC08C /**< TLS 1.2 */
148#define MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 0xC08D /**< TLS 1.2 */
Manuel Pégourié-Gonnard8d01eea2013-10-24 19:49:07 +0200149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 0xC08E /**< TLS 1.2 */
151#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 0xC08F /**< TLS 1.2 */
Manuel Pégourié-Gonnard8d01eea2013-10-24 19:49:07 +0200152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC094
154#define MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC095
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100155#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 0xC09A
156#define MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 0xC09B
Paul Bakker0f2f0bf2013-07-26 15:03:31 +0200157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#define MBEDTLS_TLS_RSA_WITH_AES_128_CCM 0xC09C /**< TLS 1.2 */
159#define MBEDTLS_TLS_RSA_WITH_AES_256_CCM 0xC09D /**< TLS 1.2 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_TLS_RSA_WITH_AES_128_CCM_8 0xC0A0 /**< TLS 1.2 */
161#define MBEDTLS_TLS_RSA_WITH_AES_256_CCM_8 0xC0A1 /**< TLS 1.2 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM 0xC0A4 /**< TLS 1.2 */
163#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM 0xC0A5 /**< TLS 1.2 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#define MBEDTLS_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8 /**< TLS 1.2 */
165#define MBEDTLS_TLS_PSK_WITH_AES_256_CCM_8 0xC0A9 /**< TLS 1.2 */
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200166/* The last two are named with PSK_DHE in the RFC, which looks like a typo */
167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM 0xC0AC /**< TLS 1.2 */
169#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM 0xC0AD /**< TLS 1.2 */
170#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE /**< TLS 1.2 */
171#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 0xC0AF /**< TLS 1.2 */
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200172
Manuel Pégourié-Gonnard538cb7b2015-09-15 18:03:28 +0200173#define MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 0xC0FF /**< experimental */
174
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200175/* RFC 7905 */
176#define MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8 /**< TLS 1.2 */
177#define MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9 /**< TLS 1.2 */
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200178#define MBEDTLS_TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAB /**< TLS 1.2 */
179#define MBEDTLS_TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 0xCCAC /**< TLS 1.2 */
Manuel Pégourié-Gonnardce66d5e2018-06-14 11:11:15 +0200180
Hanno Becker8ca26922021-07-23 19:24:23 +0100181/* RFC 8446, Appendix B.4 */
182#define MBEDTLS_TLS1_3_AES_128_GCM_SHA256 0x1301 /**< TLS 1.3 */
183#define MBEDTLS_TLS1_3_AES_256_GCM_SHA384 0x1302 /**< TLS 1.3 */
184#define MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256 0x1303 /**< TLS 1.3 */
185#define MBEDTLS_TLS1_3_AES_128_CCM_SHA256 0x1304 /**< TLS 1.3 */
186#define MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256 0x1305 /**< TLS 1.3 */
187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188/* Reminder: update mbedtls_ssl_premaster_secret when adding a new key exchange.
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100189 * Reminder: update MBEDTLS_KEY_EXCHANGE__xxx below
Manuel Pégourié-Gonnardd9423232014-12-02 11:57:29 +0100190 */
Paul Bakker68884e32013-01-07 18:20:04 +0100191typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192 MBEDTLS_KEY_EXCHANGE_NONE = 0,
193 MBEDTLS_KEY_EXCHANGE_RSA,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 MBEDTLS_KEY_EXCHANGE_ECDHE_RSA,
195 MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA,
196 MBEDTLS_KEY_EXCHANGE_PSK,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197 MBEDTLS_KEY_EXCHANGE_ECDHE_PSK,
198 MBEDTLS_KEY_EXCHANGE_ECDH_RSA,
199 MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA,
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200200 MBEDTLS_KEY_EXCHANGE_ECJPAKE,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200201} mbedtls_key_exchange_type_t;
Paul Bakker68884e32013-01-07 18:20:04 +0100202
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200203/* Key exchanges using a certificate */
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100204#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100205 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
206 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100207 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100209#define MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED
Manuel Pégourié-Gonnardd9423232014-12-02 11:57:29 +0100210#endif
211
Valerio Settic8ccc8f2023-08-02 20:00:13 +0200212/* Key exchanges in either TLS 1.2 or 1.3 which are using an ECDSA
213 * signature */
Valerio Setti2430a702023-07-13 17:22:51 +0200214#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
215 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
216#define MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED
217#endif
218
Ronald Crone68ab4f2022-10-05 12:46:29 +0200219#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
220 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
221#define MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED
222#endif
223
Manuel Pégourié-Gonnard97bb7262023-09-18 11:28:32 +0200224/* Key exchanges allowing client certificate requests.
225 *
Gilles Peskine0068fce2024-09-20 18:39:29 +0200226 * This is now the same as MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED,
227 * and the two macros could be unified.
228 * Until Mbed TLS 3.x, the two sets were different because
229 * MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED covers
230 * MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED plus RSA-PSK.
231 * But RSA-PSK was removed in Mbed TLS 4.0.
Manuel Pégourié-Gonnard97bb7262023-09-18 11:28:32 +0200232 */
Gilles Peskine0068fce2024-09-20 18:39:29 +0200233#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100234#define MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100235#endif
236
Valerio Setti568799f2023-08-18 16:27:00 +0200237/* Helper to state that certificate-based client authentication through ECDSA
Valerio Setti2430a702023-07-13 17:22:51 +0200238 * is supported in TLS 1.2 */
239#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) && \
Elena Uziunaitebed21b52024-08-27 11:56:25 +0100240 defined(PSA_HAVE_ALG_ECDSA_SIGN) && defined(PSA_HAVE_ALG_ECDSA_VERIFY)
Valerio Setti2430a702023-07-13 17:22:51 +0200241#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED
242#endif
243
Valerio Settic8ccc8f2023-08-02 20:00:13 +0200244/* ECDSA required for certificates in either TLS 1.2 or 1.3 */
245#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED) || \
246 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
247#define MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED
248#endif
249
Hanno Becker1aa267c2017-04-28 17:08:27 +0100250/* Key exchanges involving server signature in ServerKeyExchange */
Valerio Settib8621b62025-01-22 11:42:34 +0100251#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Hanno Becker1aa267c2017-04-28 17:08:27 +0100252 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100253#define MBEDTLS_KEY_EXCHANGE_WITH_SERVER_SIGNATURE_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100254#endif
255
256/* Key exchanges using ECDH */
257#if defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
258 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100259#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100260#endif
261
262/* Key exchanges that don't involve ephemeral keys */
263#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
264 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100265 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED)
266#define MBEDTLS_KEY_EXCHANGE_SOME_NON_PFS_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100267#endif
268
269/* Key exchanges that involve ephemeral keys */
Valerio Settib8621b62025-01-22 11:42:34 +0100270#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Hanno Becker1aa267c2017-04-28 17:08:27 +0100271 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
272 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
273 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100274#define MBEDTLS_KEY_EXCHANGE_SOME_PFS_ENABLED
Hanno Becker1aa267c2017-04-28 17:08:27 +0100275#endif
276
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200277/* Key exchanges using a PSK */
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100278#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100279 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100280#define MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100281#endif
282
Hanno Becker1aa267c2017-04-28 17:08:27 +0100283/* Key exchanges using ECDHE */
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100284#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
285 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
286 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +0100287#define MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED
Manuel Pégourié-Gonnardadeb7d82015-10-09 14:44:47 +0100288#endif
289
Valerio Settied365e62023-07-07 15:02:27 +0200290/* TLS 1.2 key exchanges using ECDH or ECDHE*/
Valerio Setti00dc4062023-07-05 18:48:43 +0200291#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_ENABLED) || \
292 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
293#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED
294#endif
295
Valerio Setti0a0d0d52023-07-07 15:12:45 +0200296/* TLS 1.3 PSK key exchanges */
297#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED) || \
298 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
299#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED
300#endif
301
302/* TLS 1.2 or 1.3 key exchanges with PSK */
303#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) || \
304 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
305#define MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED
306#endif
307
308/* TLS 1.3 ephemeral key exchanges */
309#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED) || \
310 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
311#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED
312#endif
313
Valerio Settiea59c432023-07-25 11:14:03 +0200314/* TLS 1.3 key exchanges using ECDHE */
Valerio Settied365e62023-07-07 15:02:27 +0200315#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED) && \
316 defined(PSA_WANT_ALG_ECDH)
317#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED
318#endif
319
320/* TLS 1.2 or 1.3 key exchanges using ECDH or ECDHE */
Valerio Setti00dc4062023-07-05 18:48:43 +0200321#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED) || \
Valerio Settied365e62023-07-07 15:02:27 +0200322 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_ECDHE_ENABLED)
Valerio Settie87915b2023-07-06 12:47:43 +0200323#define MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED
324#endif
325
Valerio Setti9cd80112023-07-25 12:04:21 +0200326/* The handshake params structure has a set of fields called xxdh_psa which are used:
Janos Follath130ece02024-11-19 16:16:36 +0000327 * - by TLS 1.2 to do ECDH or ECDHE;
Valerio Setti9cd80112023-07-25 12:04:21 +0200328 * - by TLS 1.3 to do ECDHE or FFDHE.
329 * The following macros can be used to guard their declaration and use.
330 */
Manuel Pégourié-Gonnard87381612025-01-22 12:55:54 +0100331#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Valerio Setti9cd80112023-07-25 12:04:21 +0200332#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED
333#endif
334#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_1_2_ENABLED) || \
Valerio Setti3d237b52023-07-07 16:00:20 +0200335 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Valerio Settiea59c432023-07-25 11:14:03 +0200336#define MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED
Valerio Setti3d237b52023-07-07 16:00:20 +0200337#endif
338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339typedef struct mbedtls_ssl_ciphersuite_t mbedtls_ssl_ciphersuite_t;
Paul Bakker68884e32013-01-07 18:20:04 +0100340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_CIPHERSUITE_WEAK 0x01 /**< Weak ciphersuite flag */
342#define MBEDTLS_CIPHERSUITE_SHORT_TAG 0x02 /**< Short authentication tag,
Manuel Pégourié-Gonnard6768da92014-05-14 12:26:51 +0200343 eg for CCM_8 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200344#define MBEDTLS_CIPHERSUITE_NODTLS 0x04 /**< Can't be used with DTLS */
Paul Bakker68884e32013-01-07 18:20:04 +0100345
346/**
347 * \brief This structure is used for storing ciphersuite information
Glenn Strauss60bfe602022-03-14 19:04:24 -0400348 *
349 * \note members are defined using integral types instead of enums
350 * in order to pack structure and reduce memory usage by internal
351 * \c ciphersuite_definitions[]
Paul Bakker68884e32013-01-07 18:20:04 +0100352 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100353struct mbedtls_ssl_ciphersuite_t {
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200354 int MBEDTLS_PRIVATE(id);
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 const char *MBEDTLS_PRIVATE(name);
Paul Bakker68884e32013-01-07 18:20:04 +0100356
Glenn Strauss60bfe602022-03-14 19:04:24 -0400357 uint8_t MBEDTLS_PRIVATE(cipher); /* mbedtls_cipher_type_t */
358 uint8_t MBEDTLS_PRIVATE(mac); /* mbedtls_md_type_t */
359 uint8_t MBEDTLS_PRIVATE(key_exchange); /* mbedtls_key_exchange_type_t */
360 uint8_t MBEDTLS_PRIVATE(flags);
Paul Bakker68884e32013-01-07 18:20:04 +0100361
Glenn Strauss60bfe602022-03-14 19:04:24 -0400362 uint16_t MBEDTLS_PRIVATE(min_tls_version); /* mbedtls_ssl_protocol_version */
363 uint16_t MBEDTLS_PRIVATE(max_tls_version); /* mbedtls_ssl_protocol_version */
Paul Bakker68884e32013-01-07 18:20:04 +0100364};
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366const int *mbedtls_ssl_list_ciphersuites(void);
Paul Bakker68884e32013-01-07 18:20:04 +0100367
Gilles Peskine449bd832023-01-11 14:50:10 +0100368const mbedtls_ssl_ciphersuite_t *mbedtls_ssl_ciphersuite_from_string(const char *ciphersuite_name);
369const mbedtls_ssl_ciphersuite_t *mbedtls_ssl_ciphersuite_from_id(int ciphersuite_id);
Paul Bakker68884e32013-01-07 18:20:04 +0100370
Gilles Peskine449bd832023-01-11 14:50:10 +0100371static inline const char *mbedtls_ssl_ciphersuite_get_name(const mbedtls_ssl_ciphersuite_t *info)
Glenn Strauss8f526902022-01-13 00:04:49 -0500372{
373 return info->MBEDTLS_PRIVATE(name);
374}
375
Minos Galanakis40d47082024-03-04 15:24:51 +0000376static inline int mbedtls_ssl_ciphersuite_get_id(const mbedtls_ssl_ciphersuite_t *info)
Minos Galanakis358b4482024-03-04 02:19:31 +0000377{
378 return info->MBEDTLS_PRIVATE(id);
379}
380
Gilles Peskine449bd832023-01-11 14:50:10 +0100381size_t mbedtls_ssl_ciphersuite_get_cipher_key_bitlen(const mbedtls_ssl_ciphersuite_t *info);
Glenn Strauss8f526902022-01-13 00:04:49 -0500382
Paul Bakker68884e32013-01-07 18:20:04 +0100383#ifdef __cplusplus
384}
385#endif
386
387#endif /* ssl_ciphersuites.h */