blob: 36e937ad35d2ef48a591af26ca3919c69d3591aa [file] [log] [blame]
John Durkop6e33dbe2020-09-17 21:15:13 -07001/**
2 * \file psa/crypto_config.h
3 * \brief PSA crypto configuration options (set of defines)
4 *
John Durkop7b453132020-10-12 21:56:26 -07005 */
John Durkopc7c03b72020-10-12 21:42:03 -07006#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
7/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02008 * When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled in mbedtls_config.h,
John Durkopc7c03b72020-10-12 21:42:03 -07009 * this file determines which cryptographic mechanisms are enabled
10 * through the PSA Cryptography API (\c psa_xxx() functions).
11 *
12 * To enable a cryptographic mechanism, uncomment the definition of
13 * the corresponding \c PSA_WANT_xxx preprocessor symbol.
14 * To disable a cryptographic mechanism, comment out the definition of
15 * the corresponding \c PSA_WANT_xxx preprocessor symbol.
16 * The names of cryptographic mechanisms correspond to values
17 * defined in psa/crypto_values.h, with the prefix \c PSA_WANT_ instead
18 * of \c PSA_.
19 *
20 * Note that many cryptographic mechanisms involve two symbols: one for
21 * the key type (\c PSA_WANT_KEY_TYPE_xxx) and one for the algorithm
22 * (\c PSA_WANT_ALG_xxx). Mechanisms with additional parameters may involve
23 * additional symbols.
John Durkop6e33dbe2020-09-17 21:15:13 -070024 */
John Durkopc7c03b72020-10-12 21:42:03 -070025#else
26/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020027 * When \c MBEDTLS_PSA_CRYPTO_CONFIG is disabled in mbedtls_config.h,
John Durkopc7c03b72020-10-12 21:42:03 -070028 * this file is not used, and cryptographic mechanisms are supported
29 * through the PSA API if and only if they are supported through the
30 * mbedtls_xxx API.
31 */
32#endif
John Durkop6e33dbe2020-09-17 21:15:13 -070033/*
34 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000035 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
John Durkop6e33dbe2020-09-17 21:15:13 -070036 */
37
38#ifndef PSA_CRYPTO_CONFIG_H
39#define PSA_CRYPTO_CONFIG_H
40
Ronald Crond85e98d2021-03-25 15:32:32 +010041/*
42 * CBC-MAC is not yet supported via the PSA API in Mbed TLS.
43 */
44//#define PSA_WANT_ALG_CBC_MAC 1
David Browna9f1d832021-01-15 11:40:25 -070045#define PSA_WANT_ALG_CBC_NO_PADDING 1
46#define PSA_WANT_ALG_CBC_PKCS7 1
Ronald Cron3d471812021-03-18 13:40:31 +010047#define PSA_WANT_ALG_CCM 1
Gilles Peskineecaa7ca2022-12-15 22:16:00 +010048#define PSA_WANT_ALG_CCM_STAR_NO_TAG 1
Steven Cooreman939102e2021-03-22 15:09:44 +010049#define PSA_WANT_ALG_CMAC 1
David Browna9f1d832021-01-15 11:40:25 -070050#define PSA_WANT_ALG_CFB 1
David Brown9a594e82021-02-16 12:57:27 -070051#define PSA_WANT_ALG_CHACHA20_POLY1305 1
52#define PSA_WANT_ALG_CTR 1
John Durkop0ea39e02020-10-13 19:58:20 -070053#define PSA_WANT_ALG_DETERMINISTIC_ECDSA 1
David Browna9f1d832021-01-15 11:40:25 -070054#define PSA_WANT_ALG_ECB_NO_PADDING 1
John Durkopd0321952020-10-29 21:37:36 -070055#define PSA_WANT_ALG_ECDH 1
Przemek Stekieleb511a42023-04-28 13:20:16 +020056#define PSA_WANT_ALG_FFDH 1
John Durkop07cc04a2020-11-16 22:08:34 -080057#define PSA_WANT_ALG_ECDSA 1
Neil Armstronga557cb82022-06-10 08:58:32 +020058#define PSA_WANT_ALG_JPAKE 1
Ronald Cron3d471812021-03-18 13:40:31 +010059#define PSA_WANT_ALG_GCM 1
John Durkopd0321952020-10-29 21:37:36 -070060#define PSA_WANT_ALG_HKDF 1
Przemek Stekiel3e8249c2022-06-03 14:05:07 +020061#define PSA_WANT_ALG_HKDF_EXTRACT 1
62#define PSA_WANT_ALG_HKDF_EXPAND 1
John Durkop07cc04a2020-11-16 22:08:34 -080063#define PSA_WANT_ALG_HMAC 1
John Durkopfb764a62020-11-27 08:43:28 -080064#define PSA_WANT_ALG_MD5 1
David Browna9f1d832021-01-15 11:40:25 -070065#define PSA_WANT_ALG_OFB 1
Kusumit Ghoderaoaca31652023-05-03 11:35:50 +053066#define PSA_WANT_ALG_PBKDF2_HMAC 1
Kusumit Ghoderaob3042c32023-06-27 10:39:47 +053067#define PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 1
John Durkopfb764a62020-11-27 08:43:28 -080068#define PSA_WANT_ALG_RIPEMD160 1
John Durkop07cc04a2020-11-16 22:08:34 -080069#define PSA_WANT_ALG_RSA_OAEP 1
John Durkop7fc75ea2020-11-03 19:05:36 -080070#define PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
71#define PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
John Durkop7fc75ea2020-11-03 19:05:36 -080072#define PSA_WANT_ALG_RSA_PSS 1
John Durkopfb764a62020-11-27 08:43:28 -080073#define PSA_WANT_ALG_SHA_1 1
74#define PSA_WANT_ALG_SHA_224 1
75#define PSA_WANT_ALG_SHA_256 1
76#define PSA_WANT_ALG_SHA_384 1
77#define PSA_WANT_ALG_SHA_512 1
Dave Rodgman09822a32023-06-26 11:11:23 +010078#define PSA_WANT_ALG_SHA3_224 1
Dave Rodgmanf66cd612023-06-26 11:02:12 +010079#define PSA_WANT_ALG_SHA3_256 1
Dave Rodgman09822a32023-06-26 11:11:23 +010080#define PSA_WANT_ALG_SHA3_384 1
81#define PSA_WANT_ALG_SHA3_512 1
David Browna9f1d832021-01-15 11:40:25 -070082#define PSA_WANT_ALG_STREAM_CIPHER 1
John Durkop07cc04a2020-11-16 22:08:34 -080083#define PSA_WANT_ALG_TLS12_PRF 1
84#define PSA_WANT_ALG_TLS12_PSK_TO_MS 1
Andrzej Kurek08d34b82022-07-29 10:00:16 -040085#define PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS 1
86
Gilles Peskineea4fc972023-05-22 12:18:08 +020087/* XTS is not yet supported via the PSA API in Mbed TLS.
88 * Note: when adding support, also adjust include/mbedtls/config_psa.h */
Gilles Peskine6d187af2022-03-19 10:56:13 +010089//#define PSA_WANT_ALG_XTS 1
Gilles Peskine60b29fe2021-02-16 14:06:50 +010090
David Brown32988512021-03-16 10:44:22 -060091#define PSA_WANT_ECC_BRAINPOOL_P_R1_256 1
92#define PSA_WANT_ECC_BRAINPOOL_P_R1_384 1
93#define PSA_WANT_ECC_BRAINPOOL_P_R1_512 1
David Brown3353f812021-03-02 18:36:35 -070094#define PSA_WANT_ECC_MONTGOMERY_255 1
Archanaef6aa5c2021-06-08 11:40:10 +053095#define PSA_WANT_ECC_MONTGOMERY_448 1
David Brown3353f812021-03-02 18:36:35 -070096#define PSA_WANT_ECC_SECP_K1_192 1
Ronald Crone1f55162021-03-25 15:09:47 +010097/*
98 * SECP224K1 is buggy via the PSA API in Mbed TLS
Dave Rodgman017a1992022-03-31 14:07:01 +010099 * (https://github.com/Mbed-TLS/mbedtls/issues/3541). Thus, do not enable it by
Ronald Crone1f55162021-03-25 15:09:47 +0100100 * default.
101 */
Gilles Peskine39841302021-03-23 12:06:45 +0100102//#define PSA_WANT_ECC_SECP_K1_224 1
David Brown3353f812021-03-02 18:36:35 -0700103#define PSA_WANT_ECC_SECP_K1_256 1
104#define PSA_WANT_ECC_SECP_R1_192 1
105#define PSA_WANT_ECC_SECP_R1_224 1
Gilles Peskine3aa79692023-09-20 20:54:50 +0200106/* For secp256r1, consider enabling #MBEDTLS_PSA_P256M_DRIVER_ENABLED
107 * (see the description in mbedtls/mbedtls_config.h for details). */
David Brown3353f812021-03-02 18:36:35 -0700108#define PSA_WANT_ECC_SECP_R1_256 1
109#define PSA_WANT_ECC_SECP_R1_384 1
110#define PSA_WANT_ECC_SECP_R1_521 1
David Brown20a8c432021-02-19 14:12:27 -0700111
Valerio Settibbff3032024-01-17 11:47:44 +0100112#define PSA_WANT_DH_RFC7919_2048 1
113#define PSA_WANT_DH_RFC7919_3072 1
114#define PSA_WANT_DH_RFC7919_4096 1
115#define PSA_WANT_DH_RFC7919_6144 1
116#define PSA_WANT_DH_RFC7919_8192 1
117
Gilles Peskine51b8bb02021-01-12 00:01:16 +0100118#define PSA_WANT_KEY_TYPE_DERIVE 1
Gilles Peskinebba26302022-12-15 23:25:17 +0100119#define PSA_WANT_KEY_TYPE_PASSWORD 1
120#define PSA_WANT_KEY_TYPE_PASSWORD_HASH 1
Gilles Peskine47a89332021-01-12 00:00:15 +0100121#define PSA_WANT_KEY_TYPE_HMAC 1
David Browna9f1d832021-01-15 11:40:25 -0700122#define PSA_WANT_KEY_TYPE_AES 1
Gilles Peskine09c46da2021-10-08 15:48:16 +0200123#define PSA_WANT_KEY_TYPE_ARIA 1
David Browna9f1d832021-01-15 11:40:25 -0700124#define PSA_WANT_KEY_TYPE_CAMELLIA 1
David Brown9a594e82021-02-16 12:57:27 -0700125#define PSA_WANT_KEY_TYPE_CHACHA20 1
David Browna9f1d832021-01-15 11:40:25 -0700126#define PSA_WANT_KEY_TYPE_DES 1
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200127//#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR 1 /* Deprecated */
John Durkop07cc04a2020-11-16 22:08:34 -0800128#define PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY 1
Przemek Stekieleb511a42023-04-28 13:20:16 +0200129#define PSA_WANT_KEY_TYPE_DH_PUBLIC_KEY 1
Gilles Peskine60b29fe2021-02-16 14:06:50 +0100130#define PSA_WANT_KEY_TYPE_RAW_DATA 1
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200131//#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR 1 /* Deprecated */
John Durkop7fc75ea2020-11-03 19:05:36 -0800132#define PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkop6e33dbe2020-09-17 21:15:13 -0700133
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200134/*
135 * The following symbols extend and deprecate the legacy
136 * PSA_WANT_KEY_TYPE_xxx_KEY_PAIR ones. They include the usage of that key in
137 * the name's suffix. "_USE" is the most generic and it can be used to describe
138 * a generic suport, whereas other ones add more features on top of that and
139 * they are more specific.
140 */
Valerio Setti01cc88a2023-06-15 11:53:08 +0200141#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC 1
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200142#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT 1
143#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT 1
144#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE 1
145#define PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE 1
146
Valerio Setti01cc88a2023-06-15 11:53:08 +0200147#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200148#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
149#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
150#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
151//#define PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_DERIVE 1 /* Not supported */
152
Valerio Setti01cc88a2023-06-15 11:53:08 +0200153#define PSA_WANT_KEY_TYPE_DH_KEY_PAIR_BASIC 1
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200154#define PSA_WANT_KEY_TYPE_DH_KEY_PAIR_IMPORT 1
155#define PSA_WANT_KEY_TYPE_DH_KEY_PAIR_EXPORT 1
156#define PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE 1
Valerio Setti602ee2e2023-06-06 14:10:15 +0200157//#define PSA_WANT_KEY_TYPE_DH_KEY_PAIR_DERIVE 1 /* Not supported */
Valerio Setti67a3e3e2023-05-26 13:37:26 +0200158
John Durkop6e33dbe2020-09-17 21:15:13 -0700159#endif /* PSA_CRYPTO_CONFIG_H */