blob: c29134a924fd009b751d9fe54bf3457c6f1b72d1 [file] [log] [blame]
Gilles Peskine952f4092019-05-23 20:25:48 +02001/*
Gilles Peskine3cff7682019-06-20 12:54:43 +02002 * Helper functions for tests that use the PSA Crypto API.
Gilles Peskine952f4092019-05-23 20:25:48 +02003 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman7ff79652023-11-03 12:04:52 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine952f4092019-05-23 20:25:48 +02007 */
8
Gilles Peskine1838e822019-06-20 12:40:56 +02009#ifndef PSA_CRYPTO_HELPERS_H
10#define PSA_CRYPTO_HELPERS_H
11
Ronald Cron28a45ed2021-02-09 20:35:42 +010012#include "test/helpers.h"
Gilles Peskine9de97e22021-02-02 21:00:11 +010013
14#if defined(MBEDTLS_PSA_CRYPTO_C)
15
Ronald Cron02c78b72020-05-27 09:22:32 +020016#include "test/psa_helpers.h"
Gilles Peskine952f4092019-05-23 20:25:48 +020017
Gilles Peskine3cff7682019-06-20 12:54:43 +020018#include <psa/crypto.h>
Gilles Peskine952f4092019-05-23 20:25:48 +020019
Gilles Peskine9de97e22021-02-02 21:00:11 +010020#if defined(MBEDTLS_USE_PSA_CRYPTO)
21#include "mbedtls/psa_util.h"
22#endif
23
David Horstmann9c97fda2023-12-14 14:27:50 +000024#if defined(MBEDTLS_TEST_HOOKS)
25#include "test/psa_memory_poisoning_wrappers.h"
26#endif
27
Gilles Peskine313ffb82021-02-14 12:51:14 +010028#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinee09ef872021-02-14 13:10:38 +010029
30/* Internal function for #TEST_USES_KEY_ID. Return 1 on success, 0 on failure. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010031int mbedtls_test_uses_key_id(mbedtls_svc_key_id_t key_id);
Gilles Peskinee09ef872021-02-14 13:10:38 +010032
33/** Destroy persistent keys recorded with #TEST_USES_KEY_ID.
34 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010035void mbedtls_test_psa_purge_key_storage(void);
Gilles Peskinee09ef872021-02-14 13:10:38 +010036
Gilles Peskineaae718c2021-02-14 13:46:39 +010037/** Purge the in-memory cache of persistent keys recorded with
38 * #TEST_USES_KEY_ID.
Gilles Peskine65048ad2021-02-14 14:08:22 +010039 *
40 * Call this function before calling PSA_DONE() if it's ok for
41 * persistent keys to still exist at this point.
Gilles Peskineaae718c2021-02-14 13:46:39 +010042 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010043void mbedtls_test_psa_purge_key_cache(void);
Gilles Peskineaae718c2021-02-14 13:46:39 +010044
Gilles Peskinee09ef872021-02-14 13:10:38 +010045/** \def TEST_USES_KEY_ID
46 *
47 * Call this macro in a test function before potentially creating a
48 * persistent key. Test functions that use this mechanism must call
49 * mbedtls_test_psa_purge_key_storage() in their cleanup code.
50 *
51 * This macro records a persistent key identifier as potentially used in the
52 * current test case. Recorded key identifiers will be cleaned up at the end
53 * of the test case, even on failure.
54 *
55 * This macro has no effect on volatile keys. Therefore, it is safe to call
56 * this macro in a test function that creates either volatile or persistent
57 * keys depending on the test data.
58 *
59 * This macro currently has no effect on special identifiers
60 * used to store implementation-specific files.
61 *
62 * Calling this macro multiple times on the same key identifier in the same
63 * test case has no effect.
64 *
65 * This macro can fail the test case if there isn't enough memory to
66 * record the key id.
67 *
68 * \param key_id The PSA key identifier to record.
69 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010070#define TEST_USES_KEY_ID(key_id) \
71 TEST_ASSERT(mbedtls_test_uses_key_id(key_id))
Gilles Peskinee09ef872021-02-14 13:10:38 +010072
Gilles Peskine313ffb82021-02-14 12:51:14 +010073#else /* MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskinee09ef872021-02-14 13:10:38 +010074
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010075#define TEST_USES_KEY_ID(key_id) ((void) (key_id))
76#define mbedtls_test_psa_purge_key_storage() ((void) 0)
77#define mbedtls_test_psa_purge_key_cache() ((void) 0)
Gilles Peskinee09ef872021-02-14 13:10:38 +010078
Gilles Peskine313ffb82021-02-14 12:51:14 +010079#endif /* MBEDTLS_PSA_CRYPTO_STORAGE_C */
80
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010081#define PSA_INIT() PSA_ASSERT(psa_crypto_init())
Gilles Peskine9de97e22021-02-02 21:00:11 +010082
Gilles Peskine1e005652020-11-24 17:41:07 +010083/** Check for things that have not been cleaned up properly in the
84 * PSA subsystem.
85 *
86 * \return NULL if nothing has leaked.
87 * \return A string literal explaining what has not been cleaned up
88 * if applicable.
89 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010090const char *mbedtls_test_helper_is_psa_leaking(void);
Gilles Peskinedd413d32019-05-28 15:06:43 +020091
Gilles Peskine3cff7682019-06-20 12:54:43 +020092/** Check that no PSA Crypto key slots are in use.
Gilles Peskinec85c2012021-01-06 20:47:16 +010093 *
94 * If any slots are in use, mark the current test as failed and jump to
95 * the exit label. This is equivalent to
96 * `TEST_ASSERT( ! mbedtls_test_helper_is_psa_leaking( ) )`
97 * but with a more informative message.
Gilles Peskinedd413d32019-05-28 15:06:43 +020098 */
Yanray Wang89b4d122022-10-28 18:12:01 +080099#define ASSERT_PSA_PRISTINE() \
Gilles Peskinec85c2012021-01-06 20:47:16 +0100100 do \
101 { \
Yanray Wang89b4d122022-10-28 18:12:01 +0800102 if (mbedtls_test_fail_if_psa_leaking(__LINE__, __FILE__)) \
103 goto exit; \
Gilles Peskinec85c2012021-01-06 20:47:16 +0100104 } \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100105 while (0)
Gilles Peskinea6d252a2019-05-23 20:34:30 +0200106
Gilles Peskine65048ad2021-02-14 14:08:22 +0100107/** Shut down the PSA Crypto subsystem and destroy persistent keys.
108 * Expect a clean shutdown, with no slots in use.
109 *
110 * If some key slots are still in use, record the test case as failed,
111 * but continue executing. This macro is suitable (and primarily intended)
112 * for use in the cleanup section of test functions.
113 *
114 * \note Persistent keys must be recorded with #TEST_USES_KEY_ID before
115 * creating them.
Gilles Peskinea6d252a2019-05-23 20:34:30 +0200116 */
Yanray Wang89b4d122022-10-28 18:12:01 +0800117#define PSA_DONE() \
Gilles Peskinec85c2012021-01-06 20:47:16 +0100118 do \
119 { \
Yanray Wang89b4d122022-10-28 18:12:01 +0800120 mbedtls_test_fail_if_psa_leaking(__LINE__, __FILE__); \
121 mbedtls_test_psa_purge_key_storage(); \
122 mbedtls_psa_crypto_free(); \
Gilles Peskine65048ad2021-02-14 14:08:22 +0100123 } \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100124 while (0)
Gilles Peskine65048ad2021-02-14 14:08:22 +0100125
126/** Shut down the PSA Crypto subsystem, allowing persistent keys to survive.
127 * Expect a clean shutdown, with no slots in use.
128 *
129 * If some key slots are still in use, record the test case as failed and
130 * jump to the `exit` label.
131 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100132#define PSA_SESSION_DONE() \
Gilles Peskine65048ad2021-02-14 14:08:22 +0100133 do \
134 { \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100135 mbedtls_test_psa_purge_key_cache(); \
136 ASSERT_PSA_PRISTINE(); \
137 mbedtls_psa_crypto_free(); \
Gilles Peskinec85c2012021-01-06 20:47:16 +0100138 } \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100139 while (0)
Gilles Peskinea6d252a2019-05-23 20:34:30 +0200140
Gilles Peskine51681552019-05-20 19:35:37 +0200141
142
143#if defined(RECORD_PSA_STATUS_COVERAGE_LOG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100144psa_status_t mbedtls_test_record_status(psa_status_t status,
145 const char *func,
146 const char *file, int line,
147 const char *expr);
Gilles Peskine51681552019-05-20 19:35:37 +0200148
149/** Return value logging wrapper macro.
150 *
151 * Evaluate \p expr. Write a line recording its value to the log file
152 * #STATUS_LOG_FILE_NAME and return the value. The line is a colon-separated
153 * list of fields:
154 * ```
155 * value of expr:string:__FILE__:__LINE__:expr
156 * ```
157 *
158 * The test code does not call this macro explicitly because that would
159 * be very invasive. Instead, we instrument the source code by defining
160 * a bunch of wrapper macros like
161 * ```
162 * #define psa_crypto_init() RECORD_STATUS("psa_crypto_init", psa_crypto_init())
163 * ```
164 * These macro definitions must be present in `instrument_record_status.h`
165 * when building the test suites.
166 *
167 * \param string A string, normally a function name.
168 * \param expr An expression to evaluate, normally a call of the function
169 * whose name is in \p string. This expression must return
170 * a value of type #psa_status_t.
171 * \return The value of \p expr.
172 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100173#define RECORD_STATUS(string, expr) \
174 mbedtls_test_record_status((expr), string, __FILE__, __LINE__, #expr)
Gilles Peskine51681552019-05-20 19:35:37 +0200175
176#include "instrument_record_status.h"
177
178#endif /* defined(RECORD_PSA_STATUS_COVERAGE_LOG) */
179
gabor-mezei-arm4d9009e2021-05-13 12:05:01 +0200180/** Return extended key usage policies.
181 *
182 * Do a key policy permission extension on key usage policies always involves
183 * permissions of other usage policies
Tom Cosgrove49f99bc2022-12-04 16:44:21 +0000184 * (like PSA_KEY_USAGE_SIGN_HASH involves PSA_KEY_USAGE_SIGN_MESSAGE).
gabor-mezei-arm4d9009e2021-05-13 12:05:01 +0200185 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100186psa_key_usage_t mbedtls_test_update_key_usage_flags(psa_key_usage_t usage_flags);
gabor-mezei-arm4d9009e2021-05-13 12:05:01 +0200187
Yanray Wang89b4d122022-10-28 18:12:01 +0800188/** Check that no PSA Crypto key slots are in use.
189 *
190 * If any slots are in use, mark the current test as failed.
191 *
192 * \return 0 if the key store is empty, 1 otherwise.
193 */
194int mbedtls_test_fail_if_psa_leaking(int line_no, const char *filename);
195
Gilles Peskine73521b02023-04-28 21:01:49 +0200196
197
198#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
199/* The #MBEDTLS_PSA_INJECT_ENTROPY feature requires two extra platform
200 * functions, which must be configured as #MBEDTLS_PLATFORM_NV_SEED_READ_MACRO
201 * and #MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO. The job of these functions
202 * is to read and write from the entropy seed file, which is located
203 * in the PSA ITS file whose uid is #PSA_CRYPTO_ITS_RANDOM_SEED_UID.
204 * (These could have been provided as library functions, but for historical
205 * reasons, they weren't, and so each integrator has to provide a copy
206 * of these functions.)
207 *
208 * Provide implementations of these functions for testing. */
209int mbedtls_test_inject_entropy_seed_read(unsigned char *buf, size_t len);
210int mbedtls_test_inject_entropy_seed_write(unsigned char *buf, size_t len);
Gilles Peskine4f8bf3c2023-04-28 23:39:45 +0200211
212
213/** Make sure that the injected entropy is present.
214 *
215 * When MBEDTLS_PSA_INJECT_ENTROPY is enabled, psa_crypto_init()
216 * will fail if the PSA entropy seed is not present.
217 * This function must be called at least once in a test suite or other
218 * program before any call to psa_crypto_init().
219 * It does not need to be called in each test case.
220 *
221 * The test framework calls this function before running any test case.
222 *
223 * The few tests that might remove the entropy file must call this function
224 * in their cleanup.
225 */
226int mbedtls_test_inject_entropy_restore(void);
Gilles Peskine73521b02023-04-28 21:01:49 +0200227#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
228
229
230
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100231/** Skip a test case if the given key is a 192 bits AES key and the AES
232 * implementation is at least partially provided by an accelerator or
Ronald Cron28a45ed2021-02-09 20:35:42 +0100233 * alternative implementation.
234 *
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100235 * Call this macro in a test case when a cryptographic operation that may
236 * involve an AES operation returns a #PSA_ERROR_NOT_SUPPORTED error code.
237 * The macro call will skip and not fail the test case in case the operation
238 * involves a 192 bits AES key and the AES implementation is at least
239 * partially provided by an accelerator or alternative implementation.
240 *
241 * Hardware AES implementations not supporting 192 bits keys commonly exist.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100242 * Consequently, PSA test cases aim at not failing when an AES operation with
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100243 * a 192 bits key performed by an alternative AES implementation returns
244 * with the #PSA_ERROR_NOT_SUPPORTED error code. The purpose of this macro
245 * is to facilitate this and make the test case code more readable.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100246 *
247 * \param key_type Key type
248 * \param key_bits Key length in number of bits.
249 */
250#if defined(MBEDTLS_AES_ALT) || \
251 defined(MBEDTLS_AES_SETKEY_ENC_ALT) || \
252 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_AES)
253#define MBEDTLS_TEST_HAVE_ALT_AES 1
254#else
255#define MBEDTLS_TEST_HAVE_ALT_AES 0
256#endif
257
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100258#define MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192(key_type, key_bits) \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100259 do \
260 { \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100261 if ((MBEDTLS_TEST_HAVE_ALT_AES) && \
262 ((key_type) == PSA_KEY_TYPE_AES) && \
263 (key_bits == 192)) \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100264 { \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100265 mbedtls_test_skip("AES-192 not supported", __LINE__, __FILE__); \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100266 goto exit; \
267 } \
268 } \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100269 while (0)
Ronald Cron28a45ed2021-02-09 20:35:42 +0100270
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100271/** Skip a test case if a GCM operation with a nonce length different from
272 * 12 bytes fails and was performed by an accelerator or alternative
273 * implementation.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100274 *
275 * Call this macro in a test case when an AEAD cryptography operation that
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100276 * may involve the GCM mode returns with a #PSA_ERROR_NOT_SUPPORTED error
277 * code. The macro call will skip and not fail the test case in case the
278 * operation involves the GCM mode, a nonce with a length different from
279 * 12 bytes and the GCM mode implementation is an alternative one.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100280 *
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100281 * Hardware GCM implementations not supporting nonce lengths different from
282 * 12 bytes commonly exist, as supporting a non-12-byte nonce requires
283 * additional computations involving the GHASH function.
284 * Consequently, PSA test cases aim at not failing when an AEAD operation in
285 * GCM mode with a nonce length different from 12 bytes is performed by an
286 * alternative GCM implementation and returns with a #PSA_ERROR_NOT_SUPPORTED
287 * error code. The purpose of this macro is to facilitate this check and make
288 * the test case code more readable.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100289 *
Steven Cooreman1e9c0422021-02-10 17:02:05 +0100290 * \param alg The AEAD algorithm.
291 * \param nonce_length The nonce length in number of bytes.
Ronald Cron28a45ed2021-02-09 20:35:42 +0100292 */
Ronald Cron28a45ed2021-02-09 20:35:42 +0100293#if defined(MBEDTLS_GCM_ALT) || \
294 defined(MBEDTLS_PSA_ACCEL_ALG_GCM)
295#define MBEDTLS_TEST_HAVE_ALT_GCM 1
296#else
297#define MBEDTLS_TEST_HAVE_ALT_GCM 0
298#endif
299
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100300#define MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE(alg, \
301 nonce_length) \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100302 do \
303 { \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100304 if ((MBEDTLS_TEST_HAVE_ALT_GCM) && \
305 (PSA_ALG_AEAD_WITH_SHORTENED_TAG((alg), 0) == \
306 PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0)) && \
307 ((nonce_length) != 12)) \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100308 { \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100309 mbedtls_test_skip("GCM with non-12-byte IV is not supported", __LINE__, __FILE__); \
Ronald Cron28a45ed2021-02-09 20:35:42 +0100310 goto exit; \
311 } \
312 } \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100313 while (0)
Ronald Cron28a45ed2021-02-09 20:35:42 +0100314
Gilles Peskine9de97e22021-02-02 21:00:11 +0100315#endif /* MBEDTLS_PSA_CRYPTO_C */
316
317/** \def USE_PSA_INIT
318 *
319 * Call this macro to initialize the PSA subsystem if #MBEDTLS_USE_PSA_CRYPTO
320 * is enabled and do nothing otherwise. If the initialization fails, mark
321 * the test case as failed and jump to the \p exit label.
322 */
323/** \def USE_PSA_DONE
324 *
325 * Call this macro at the end of a test case if you called #USE_PSA_INIT.
326 * This is like #PSA_DONE, except that it does nothing if
327 * #MBEDTLS_USE_PSA_CRYPTO is disabled.
328 */
329#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100330#define USE_PSA_INIT() PSA_INIT()
331#define USE_PSA_DONE() PSA_DONE()
Gilles Peskine9de97e22021-02-02 21:00:11 +0100332#else /* MBEDTLS_USE_PSA_CRYPTO */
333/* Define empty macros so that we can use them in the preamble and teardown
334 * of every test function that uses PSA conditionally based on
335 * MBEDTLS_USE_PSA_CRYPTO. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100336#define USE_PSA_INIT() ((void) 0)
337#define USE_PSA_DONE() ((void) 0)
Gilles Peskine9de97e22021-02-02 21:00:11 +0100338#endif /* !MBEDTLS_USE_PSA_CRYPTO */
339
Gilles Peskine1838e822019-06-20 12:40:56 +0200340#endif /* PSA_CRYPTO_HELPERS_H */