Gilles Peskine | 952f409 | 2019-05-23 20:25:48 +0200 | [diff] [blame] | 1 | /* |
Gilles Peskine | 3cff768 | 2019-06-20 12:54:43 +0200 | [diff] [blame] | 2 | * Helper functions for tests that use the PSA Crypto API. |
Gilles Peskine | 952f409 | 2019-05-23 20:25:48 +0200 | [diff] [blame] | 3 | */ |
Bence Szépkúti | 8697465 | 2020-06-15 11:59:37 +0200 | [diff] [blame] | 4 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 5 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 7ff7965 | 2023-11-03 12:04:52 +0000 | [diff] [blame^] | 6 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Gilles Peskine | 952f409 | 2019-05-23 20:25:48 +0200 | [diff] [blame] | 7 | */ |
| 8 | |
Gilles Peskine | 1838e82 | 2019-06-20 12:40:56 +0200 | [diff] [blame] | 9 | #ifndef PSA_CRYPTO_HELPERS_H |
| 10 | #define PSA_CRYPTO_HELPERS_H |
| 11 | |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 12 | #include "test/helpers.h" |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 13 | |
| 14 | #if defined(MBEDTLS_PSA_CRYPTO_C) |
| 15 | |
Ronald Cron | 02c78b7 | 2020-05-27 09:22:32 +0200 | [diff] [blame] | 16 | #include "test/psa_helpers.h" |
Gilles Peskine | 952f409 | 2019-05-23 20:25:48 +0200 | [diff] [blame] | 17 | |
Gilles Peskine | 3cff768 | 2019-06-20 12:54:43 +0200 | [diff] [blame] | 18 | #include <psa/crypto.h> |
Gilles Peskine | 952f409 | 2019-05-23 20:25:48 +0200 | [diff] [blame] | 19 | |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 20 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 21 | #include "mbedtls/psa_util.h" |
| 22 | #endif |
| 23 | |
Gilles Peskine | 313ffb8 | 2021-02-14 12:51:14 +0100 | [diff] [blame] | 24 | #if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 25 | |
| 26 | /* Internal function for #TEST_USES_KEY_ID. Return 1 on success, 0 on failure. */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 27 | int mbedtls_test_uses_key_id(mbedtls_svc_key_id_t key_id); |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 28 | |
| 29 | /** Destroy persistent keys recorded with #TEST_USES_KEY_ID. |
| 30 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 31 | void mbedtls_test_psa_purge_key_storage(void); |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 32 | |
Gilles Peskine | aae718c | 2021-02-14 13:46:39 +0100 | [diff] [blame] | 33 | /** Purge the in-memory cache of persistent keys recorded with |
| 34 | * #TEST_USES_KEY_ID. |
Gilles Peskine | 65048ad | 2021-02-14 14:08:22 +0100 | [diff] [blame] | 35 | * |
| 36 | * Call this function before calling PSA_DONE() if it's ok for |
| 37 | * persistent keys to still exist at this point. |
Gilles Peskine | aae718c | 2021-02-14 13:46:39 +0100 | [diff] [blame] | 38 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 39 | void mbedtls_test_psa_purge_key_cache(void); |
Gilles Peskine | aae718c | 2021-02-14 13:46:39 +0100 | [diff] [blame] | 40 | |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 41 | /** \def TEST_USES_KEY_ID |
| 42 | * |
| 43 | * Call this macro in a test function before potentially creating a |
| 44 | * persistent key. Test functions that use this mechanism must call |
| 45 | * mbedtls_test_psa_purge_key_storage() in their cleanup code. |
| 46 | * |
| 47 | * This macro records a persistent key identifier as potentially used in the |
| 48 | * current test case. Recorded key identifiers will be cleaned up at the end |
| 49 | * of the test case, even on failure. |
| 50 | * |
| 51 | * This macro has no effect on volatile keys. Therefore, it is safe to call |
| 52 | * this macro in a test function that creates either volatile or persistent |
| 53 | * keys depending on the test data. |
| 54 | * |
| 55 | * This macro currently has no effect on special identifiers |
| 56 | * used to store implementation-specific files. |
| 57 | * |
| 58 | * Calling this macro multiple times on the same key identifier in the same |
| 59 | * test case has no effect. |
| 60 | * |
| 61 | * This macro can fail the test case if there isn't enough memory to |
| 62 | * record the key id. |
| 63 | * |
| 64 | * \param key_id The PSA key identifier to record. |
| 65 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 66 | #define TEST_USES_KEY_ID(key_id) \ |
| 67 | TEST_ASSERT(mbedtls_test_uses_key_id(key_id)) |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 68 | |
Gilles Peskine | 313ffb8 | 2021-02-14 12:51:14 +0100 | [diff] [blame] | 69 | #else /* MBEDTLS_PSA_CRYPTO_STORAGE_C */ |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 70 | |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 71 | #define TEST_USES_KEY_ID(key_id) ((void) (key_id)) |
| 72 | #define mbedtls_test_psa_purge_key_storage() ((void) 0) |
| 73 | #define mbedtls_test_psa_purge_key_cache() ((void) 0) |
Gilles Peskine | e09ef87 | 2021-02-14 13:10:38 +0100 | [diff] [blame] | 74 | |
Gilles Peskine | 313ffb8 | 2021-02-14 12:51:14 +0100 | [diff] [blame] | 75 | #endif /* MBEDTLS_PSA_CRYPTO_STORAGE_C */ |
| 76 | |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 77 | #define PSA_INIT() PSA_ASSERT(psa_crypto_init()) |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 78 | |
Gilles Peskine | 1e00565 | 2020-11-24 17:41:07 +0100 | [diff] [blame] | 79 | /** Check for things that have not been cleaned up properly in the |
| 80 | * PSA subsystem. |
| 81 | * |
| 82 | * \return NULL if nothing has leaked. |
| 83 | * \return A string literal explaining what has not been cleaned up |
| 84 | * if applicable. |
| 85 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 86 | const char *mbedtls_test_helper_is_psa_leaking(void); |
Gilles Peskine | dd413d3 | 2019-05-28 15:06:43 +0200 | [diff] [blame] | 87 | |
Gilles Peskine | 3cff768 | 2019-06-20 12:54:43 +0200 | [diff] [blame] | 88 | /** Check that no PSA Crypto key slots are in use. |
Gilles Peskine | c85c201 | 2021-01-06 20:47:16 +0100 | [diff] [blame] | 89 | * |
| 90 | * If any slots are in use, mark the current test as failed and jump to |
| 91 | * the exit label. This is equivalent to |
| 92 | * `TEST_ASSERT( ! mbedtls_test_helper_is_psa_leaking( ) )` |
| 93 | * but with a more informative message. |
Gilles Peskine | dd413d3 | 2019-05-28 15:06:43 +0200 | [diff] [blame] | 94 | */ |
Yanray Wang | 89b4d12 | 2022-10-28 18:12:01 +0800 | [diff] [blame] | 95 | #define ASSERT_PSA_PRISTINE() \ |
Gilles Peskine | c85c201 | 2021-01-06 20:47:16 +0100 | [diff] [blame] | 96 | do \ |
| 97 | { \ |
Yanray Wang | 89b4d12 | 2022-10-28 18:12:01 +0800 | [diff] [blame] | 98 | if (mbedtls_test_fail_if_psa_leaking(__LINE__, __FILE__)) \ |
| 99 | goto exit; \ |
Gilles Peskine | c85c201 | 2021-01-06 20:47:16 +0100 | [diff] [blame] | 100 | } \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 101 | while (0) |
Gilles Peskine | a6d252a | 2019-05-23 20:34:30 +0200 | [diff] [blame] | 102 | |
Gilles Peskine | 65048ad | 2021-02-14 14:08:22 +0100 | [diff] [blame] | 103 | /** Shut down the PSA Crypto subsystem and destroy persistent keys. |
| 104 | * Expect a clean shutdown, with no slots in use. |
| 105 | * |
| 106 | * If some key slots are still in use, record the test case as failed, |
| 107 | * but continue executing. This macro is suitable (and primarily intended) |
| 108 | * for use in the cleanup section of test functions. |
| 109 | * |
| 110 | * \note Persistent keys must be recorded with #TEST_USES_KEY_ID before |
| 111 | * creating them. |
Gilles Peskine | a6d252a | 2019-05-23 20:34:30 +0200 | [diff] [blame] | 112 | */ |
Yanray Wang | 89b4d12 | 2022-10-28 18:12:01 +0800 | [diff] [blame] | 113 | #define PSA_DONE() \ |
Gilles Peskine | c85c201 | 2021-01-06 20:47:16 +0100 | [diff] [blame] | 114 | do \ |
| 115 | { \ |
Yanray Wang | 89b4d12 | 2022-10-28 18:12:01 +0800 | [diff] [blame] | 116 | mbedtls_test_fail_if_psa_leaking(__LINE__, __FILE__); \ |
| 117 | mbedtls_test_psa_purge_key_storage(); \ |
| 118 | mbedtls_psa_crypto_free(); \ |
Gilles Peskine | 65048ad | 2021-02-14 14:08:22 +0100 | [diff] [blame] | 119 | } \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 120 | while (0) |
Gilles Peskine | 65048ad | 2021-02-14 14:08:22 +0100 | [diff] [blame] | 121 | |
| 122 | /** Shut down the PSA Crypto subsystem, allowing persistent keys to survive. |
| 123 | * Expect a clean shutdown, with no slots in use. |
| 124 | * |
| 125 | * If some key slots are still in use, record the test case as failed and |
| 126 | * jump to the `exit` label. |
| 127 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 128 | #define PSA_SESSION_DONE() \ |
Gilles Peskine | 65048ad | 2021-02-14 14:08:22 +0100 | [diff] [blame] | 129 | do \ |
| 130 | { \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 131 | mbedtls_test_psa_purge_key_cache(); \ |
| 132 | ASSERT_PSA_PRISTINE(); \ |
| 133 | mbedtls_psa_crypto_free(); \ |
Gilles Peskine | c85c201 | 2021-01-06 20:47:16 +0100 | [diff] [blame] | 134 | } \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 135 | while (0) |
Gilles Peskine | a6d252a | 2019-05-23 20:34:30 +0200 | [diff] [blame] | 136 | |
Gilles Peskine | 5168155 | 2019-05-20 19:35:37 +0200 | [diff] [blame] | 137 | |
| 138 | |
| 139 | #if defined(RECORD_PSA_STATUS_COVERAGE_LOG) |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 140 | psa_status_t mbedtls_test_record_status(psa_status_t status, |
| 141 | const char *func, |
| 142 | const char *file, int line, |
| 143 | const char *expr); |
Gilles Peskine | 5168155 | 2019-05-20 19:35:37 +0200 | [diff] [blame] | 144 | |
| 145 | /** Return value logging wrapper macro. |
| 146 | * |
| 147 | * Evaluate \p expr. Write a line recording its value to the log file |
| 148 | * #STATUS_LOG_FILE_NAME and return the value. The line is a colon-separated |
| 149 | * list of fields: |
| 150 | * ``` |
| 151 | * value of expr:string:__FILE__:__LINE__:expr |
| 152 | * ``` |
| 153 | * |
| 154 | * The test code does not call this macro explicitly because that would |
| 155 | * be very invasive. Instead, we instrument the source code by defining |
| 156 | * a bunch of wrapper macros like |
| 157 | * ``` |
| 158 | * #define psa_crypto_init() RECORD_STATUS("psa_crypto_init", psa_crypto_init()) |
| 159 | * ``` |
| 160 | * These macro definitions must be present in `instrument_record_status.h` |
| 161 | * when building the test suites. |
| 162 | * |
| 163 | * \param string A string, normally a function name. |
| 164 | * \param expr An expression to evaluate, normally a call of the function |
| 165 | * whose name is in \p string. This expression must return |
| 166 | * a value of type #psa_status_t. |
| 167 | * \return The value of \p expr. |
| 168 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 169 | #define RECORD_STATUS(string, expr) \ |
| 170 | mbedtls_test_record_status((expr), string, __FILE__, __LINE__, #expr) |
Gilles Peskine | 5168155 | 2019-05-20 19:35:37 +0200 | [diff] [blame] | 171 | |
| 172 | #include "instrument_record_status.h" |
| 173 | |
| 174 | #endif /* defined(RECORD_PSA_STATUS_COVERAGE_LOG) */ |
| 175 | |
gabor-mezei-arm | 4d9009e | 2021-05-13 12:05:01 +0200 | [diff] [blame] | 176 | /** Return extended key usage policies. |
| 177 | * |
| 178 | * Do a key policy permission extension on key usage policies always involves |
| 179 | * permissions of other usage policies |
Tom Cosgrove | 49f99bc | 2022-12-04 16:44:21 +0000 | [diff] [blame] | 180 | * (like PSA_KEY_USAGE_SIGN_HASH involves PSA_KEY_USAGE_SIGN_MESSAGE). |
gabor-mezei-arm | 4d9009e | 2021-05-13 12:05:01 +0200 | [diff] [blame] | 181 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 182 | psa_key_usage_t mbedtls_test_update_key_usage_flags(psa_key_usage_t usage_flags); |
gabor-mezei-arm | 4d9009e | 2021-05-13 12:05:01 +0200 | [diff] [blame] | 183 | |
Yanray Wang | 89b4d12 | 2022-10-28 18:12:01 +0800 | [diff] [blame] | 184 | /** Check that no PSA Crypto key slots are in use. |
| 185 | * |
| 186 | * If any slots are in use, mark the current test as failed. |
| 187 | * |
| 188 | * \return 0 if the key store is empty, 1 otherwise. |
| 189 | */ |
| 190 | int mbedtls_test_fail_if_psa_leaking(int line_no, const char *filename); |
| 191 | |
Gilles Peskine | 73521b0 | 2023-04-28 21:01:49 +0200 | [diff] [blame] | 192 | |
| 193 | |
| 194 | #if defined(MBEDTLS_PSA_INJECT_ENTROPY) |
| 195 | /* The #MBEDTLS_PSA_INJECT_ENTROPY feature requires two extra platform |
| 196 | * functions, which must be configured as #MBEDTLS_PLATFORM_NV_SEED_READ_MACRO |
| 197 | * and #MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO. The job of these functions |
| 198 | * is to read and write from the entropy seed file, which is located |
| 199 | * in the PSA ITS file whose uid is #PSA_CRYPTO_ITS_RANDOM_SEED_UID. |
| 200 | * (These could have been provided as library functions, but for historical |
| 201 | * reasons, they weren't, and so each integrator has to provide a copy |
| 202 | * of these functions.) |
| 203 | * |
| 204 | * Provide implementations of these functions for testing. */ |
| 205 | int mbedtls_test_inject_entropy_seed_read(unsigned char *buf, size_t len); |
| 206 | int mbedtls_test_inject_entropy_seed_write(unsigned char *buf, size_t len); |
Gilles Peskine | 4f8bf3c | 2023-04-28 23:39:45 +0200 | [diff] [blame] | 207 | |
| 208 | |
| 209 | /** Make sure that the injected entropy is present. |
| 210 | * |
| 211 | * When MBEDTLS_PSA_INJECT_ENTROPY is enabled, psa_crypto_init() |
| 212 | * will fail if the PSA entropy seed is not present. |
| 213 | * This function must be called at least once in a test suite or other |
| 214 | * program before any call to psa_crypto_init(). |
| 215 | * It does not need to be called in each test case. |
| 216 | * |
| 217 | * The test framework calls this function before running any test case. |
| 218 | * |
| 219 | * The few tests that might remove the entropy file must call this function |
| 220 | * in their cleanup. |
| 221 | */ |
| 222 | int mbedtls_test_inject_entropy_restore(void); |
Gilles Peskine | 73521b0 | 2023-04-28 21:01:49 +0200 | [diff] [blame] | 223 | #endif /* MBEDTLS_PSA_INJECT_ENTROPY */ |
| 224 | |
| 225 | |
| 226 | |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 227 | /** Skip a test case if the given key is a 192 bits AES key and the AES |
| 228 | * implementation is at least partially provided by an accelerator or |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 229 | * alternative implementation. |
| 230 | * |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 231 | * Call this macro in a test case when a cryptographic operation that may |
| 232 | * involve an AES operation returns a #PSA_ERROR_NOT_SUPPORTED error code. |
| 233 | * The macro call will skip and not fail the test case in case the operation |
| 234 | * involves a 192 bits AES key and the AES implementation is at least |
| 235 | * partially provided by an accelerator or alternative implementation. |
| 236 | * |
| 237 | * Hardware AES implementations not supporting 192 bits keys commonly exist. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 238 | * Consequently, PSA test cases aim at not failing when an AES operation with |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 239 | * a 192 bits key performed by an alternative AES implementation returns |
| 240 | * with the #PSA_ERROR_NOT_SUPPORTED error code. The purpose of this macro |
| 241 | * is to facilitate this and make the test case code more readable. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 242 | * |
| 243 | * \param key_type Key type |
| 244 | * \param key_bits Key length in number of bits. |
| 245 | */ |
| 246 | #if defined(MBEDTLS_AES_ALT) || \ |
| 247 | defined(MBEDTLS_AES_SETKEY_ENC_ALT) || \ |
| 248 | defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_AES) |
| 249 | #define MBEDTLS_TEST_HAVE_ALT_AES 1 |
| 250 | #else |
| 251 | #define MBEDTLS_TEST_HAVE_ALT_AES 0 |
| 252 | #endif |
| 253 | |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 254 | #define MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192(key_type, key_bits) \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 255 | do \ |
| 256 | { \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 257 | if ((MBEDTLS_TEST_HAVE_ALT_AES) && \ |
| 258 | ((key_type) == PSA_KEY_TYPE_AES) && \ |
| 259 | (key_bits == 192)) \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 260 | { \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 261 | mbedtls_test_skip("AES-192 not supported", __LINE__, __FILE__); \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 262 | goto exit; \ |
| 263 | } \ |
| 264 | } \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 265 | while (0) |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 266 | |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 267 | /** Skip a test case if a GCM operation with a nonce length different from |
| 268 | * 12 bytes fails and was performed by an accelerator or alternative |
| 269 | * implementation. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 270 | * |
| 271 | * Call this macro in a test case when an AEAD cryptography operation that |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 272 | * may involve the GCM mode returns with a #PSA_ERROR_NOT_SUPPORTED error |
| 273 | * code. The macro call will skip and not fail the test case in case the |
| 274 | * operation involves the GCM mode, a nonce with a length different from |
| 275 | * 12 bytes and the GCM mode implementation is an alternative one. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 276 | * |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 277 | * Hardware GCM implementations not supporting nonce lengths different from |
| 278 | * 12 bytes commonly exist, as supporting a non-12-byte nonce requires |
| 279 | * additional computations involving the GHASH function. |
| 280 | * Consequently, PSA test cases aim at not failing when an AEAD operation in |
| 281 | * GCM mode with a nonce length different from 12 bytes is performed by an |
| 282 | * alternative GCM implementation and returns with a #PSA_ERROR_NOT_SUPPORTED |
| 283 | * error code. The purpose of this macro is to facilitate this check and make |
| 284 | * the test case code more readable. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 285 | * |
Steven Cooreman | 1e9c042 | 2021-02-10 17:02:05 +0100 | [diff] [blame] | 286 | * \param alg The AEAD algorithm. |
| 287 | * \param nonce_length The nonce length in number of bytes. |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 288 | */ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 289 | #if defined(MBEDTLS_GCM_ALT) || \ |
| 290 | defined(MBEDTLS_PSA_ACCEL_ALG_GCM) |
| 291 | #define MBEDTLS_TEST_HAVE_ALT_GCM 1 |
| 292 | #else |
| 293 | #define MBEDTLS_TEST_HAVE_ALT_GCM 0 |
| 294 | #endif |
| 295 | |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 296 | #define MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE(alg, \ |
| 297 | nonce_length) \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 298 | do \ |
| 299 | { \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 300 | if ((MBEDTLS_TEST_HAVE_ALT_GCM) && \ |
| 301 | (PSA_ALG_AEAD_WITH_SHORTENED_TAG((alg), 0) == \ |
| 302 | PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0)) && \ |
| 303 | ((nonce_length) != 12)) \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 304 | { \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 305 | mbedtls_test_skip("GCM with non-12-byte IV is not supported", __LINE__, __FILE__); \ |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 306 | goto exit; \ |
| 307 | } \ |
| 308 | } \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 309 | while (0) |
Ronald Cron | 28a45ed | 2021-02-09 20:35:42 +0100 | [diff] [blame] | 310 | |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 311 | #endif /* MBEDTLS_PSA_CRYPTO_C */ |
| 312 | |
| 313 | /** \def USE_PSA_INIT |
| 314 | * |
| 315 | * Call this macro to initialize the PSA subsystem if #MBEDTLS_USE_PSA_CRYPTO |
| 316 | * is enabled and do nothing otherwise. If the initialization fails, mark |
| 317 | * the test case as failed and jump to the \p exit label. |
| 318 | */ |
| 319 | /** \def USE_PSA_DONE |
| 320 | * |
| 321 | * Call this macro at the end of a test case if you called #USE_PSA_INIT. |
| 322 | * This is like #PSA_DONE, except that it does nothing if |
| 323 | * #MBEDTLS_USE_PSA_CRYPTO is disabled. |
| 324 | */ |
| 325 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 326 | #define USE_PSA_INIT() PSA_INIT() |
| 327 | #define USE_PSA_DONE() PSA_DONE() |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 328 | #else /* MBEDTLS_USE_PSA_CRYPTO */ |
| 329 | /* Define empty macros so that we can use them in the preamble and teardown |
| 330 | * of every test function that uses PSA conditionally based on |
| 331 | * MBEDTLS_USE_PSA_CRYPTO. */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 332 | #define USE_PSA_INIT() ((void) 0) |
| 333 | #define USE_PSA_DONE() ((void) 0) |
Gilles Peskine | 9de97e2 | 2021-02-02 21:00:11 +0100 | [diff] [blame] | 334 | #endif /* !MBEDTLS_USE_PSA_CRYPTO */ |
| 335 | |
Gilles Peskine | 1838e82 | 2019-06-20 12:40:56 +0200 | [diff] [blame] | 336 | #endif /* PSA_CRYPTO_HELPERS_H */ |