Test with bad data in storage: key IDs

Test what happens when the application tries to access a key and the storage
contains something invalid: either a corrupted file, or a key ID that's
outside the standard range for persistent keys.

Coverage of APIs in this commit:

* `psa_get_key_attributes()` (generally as a proxy for any key access);
* `psa_export_key()` (minor, but does provide some coverage of what happens
  if only the key material is corrupted);
* `psa_destroy_key()`, which hopefully should work even for a corrupted file.

Coverage of key IDs in this commit:

* Key IDs in various ranges: user (i.e. the normal range for persistent
  keys), builtin, volatile, reserved file ID, none of the above.
* Includes coverage for nonzero owner ID.

No coverage of corrupted files in this commit.

Assert the behavior that I think is the right thing. Subsequent commits will
reconcile the library behavior with the code as needed.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2025-10-23 13:15:50 +02:00
committed by Valerio Setti
parent 3e5d0c1202
commit 32dbf968c8
2 changed files with 300 additions and 0 deletions

View File

@@ -136,3 +136,150 @@ destroy_nonexistent:1:PSA_ERROR_INVALID_HANDLE
Destroy invalid id: 0xffffffff
destroy_nonexistent:0xffffffff:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=1, good, 1 byte
load_primed_storage:0:1:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=0 id=2, good
load_primed_storage:0:2:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=0 id=PSA_KEY_USER_MIN, good
load_primed_storage:0:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=0 id=PSA_KEY_USER_MAX, good
load_primed_storage:0:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=0 id=0 (bad id)
load_primed_storage:0:0:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_SUCCESS
Load key: owner=0 id=PSA_KEY_ID_VOLATILE_MIN (bad id)
load_primed_storage:0:PSA_KEY_ID_VOLATILE_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=PSA_KEY_ID_VOLATILE_MAX (bad id)
load_primed_storage:0:PSA_KEY_ID_VOLATILE_MAX:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
# We use the numerical ID in the test data because the numerical range
# of built-in keys is part of the interface contract between the library
# and third-party code that provide built-in keys. We can extend this
# range, but shrinking it would be an incompatible change.
Load key: owner=0 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MIN (bad id)
load_primed_storage:0:0x7fff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MAX (bad id)
load_primed_storage:0:0x7fffefff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=0x7fffffff (bad id: not in any range)
load_primed_storage:0:KEY_ID_OUTSIDE_DEFINED_RANGES:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=0xffff0000 (bad id: reserved file UID, not in use)
load_primed_storage:0:0xffff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=entropy file seed
load_primed_storage:0:PSA_CRYPTO_ITS_RANDOM_SEED_UID:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=0 id=0xffffffff (bad id: reserved file UID, not in use)
load_primed_storage:0:0xffffffff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=2, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:2:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=42 id=PSA_KEY_USER_MIN, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=42 id=PSA_KEY_USER_MAX, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=42 id=0 (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:0:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_SUCCESS
Load key: owner=42 id=PSA_KEY_ID_VOLATILE_MIN (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:PSA_KEY_ID_VOLATILE_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=PSA_KEY_ID_VOLATILE_MAX (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:PSA_KEY_ID_VOLATILE_MAX:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
# We use the numerical ID in the test data because the numerical range
# of built-in keys is part of the interface contract between the library
# and third-party code that provide built-in keys. We can extend this
# range, but shrinking it would be an incompatible change.
Load key: owner=42 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MIN (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:0x7fff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MAX (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:0x7fffefff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=0x7fffffff (bad id: not in any range)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:KEY_ID_OUTSIDE_DEFINED_RANGES:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=0xffff0000 (bad id: reserved file UID, not in use)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:0xffff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=(entropy file seed & 0xffffffff)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:PSA_CRYPTO_ITS_RANDOM_SEED_UID:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=42 id=0xffffffff (bad id: reserved file UID, not in use)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:42:0xffffffff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=2, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:2:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=-0x80000000 id=PSA_KEY_USER_MIN, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=-0x80000000 id=PSA_KEY_USER_MAX, good
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:PSA_KEY_ID_USER_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_SUCCESS:PSA_SUCCESS:PSA_SUCCESS
Load key: owner=-0x80000000 id=0 (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:0:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_SUCCESS
Load key: owner=-0x80000000 id=PSA_KEY_ID_VOLATILE_MIN (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:PSA_KEY_ID_VOLATILE_MIN:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=PSA_KEY_ID_VOLATILE_MAX (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:PSA_KEY_ID_VOLATILE_MAX:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
# We use the numerical ID in the test data because the numerical range
# of built-in keys is part of the interface contract between the library
# and third-party code that provide built-in keys. We can extend this
# range, but shrinking it would be an incompatible change.
Load key: owner=-0x80000000 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MIN (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:0x7fff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=MBEDTLS_PSA_KEY_ID_BUILTIN_MAX (bad id)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:0x7fffefff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=0x7fffffff (bad id: not in any range)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:KEY_ID_OUTSIDE_DEFINED_RANGES:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=0xffff0000 (bad id: reserved file UID, not in use)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:0xffff0000:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=(entropy file seed & 0xffffffff)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:PSA_CRYPTO_ITS_RANDOM_SEED_UID:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE
Load key: owner=-0x80000000 id=0xffffffff (bad id: reserved file UID, not in use)
depends_on:MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
load_primed_storage:-0x80000000:0xffffffff:"505341004b455900000000000100000001100800010000000000000000000000010000004c":PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE:PSA_ERROR_INVALID_HANDLE

View File

@@ -14,9 +14,32 @@
#include <stdint.h>
#include "mbedtls/ctr_drbg.h"
#include "psa_crypto_its.h"
#include "psa_crypto_slot_management.h"
#include "psa_crypto_storage.h"
#define KEY_ID_IN_USER_RANGE(id) \
(PSA_KEY_ID_USER_MIN <= (id) && (id) <= PSA_KEY_ID_USER_MAX)
#define KEY_ID_IN_VOLATILE_RANGE(id) \
(PSA_KEY_ID_VOLATILE_MIN <= (id) && (id) <= PSA_KEY_ID_VOLATILE_MAX)
#if defined(MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS)
#define KEY_ID_IN_BUILTIN_RANGE(id) \
(MBEDTLS_PSA_KEY_ID_BUILTIN_MIN <= (id) && (id) <= MBEDTLS_PSA_KEY_ID_BUILTIN_MAX)
#else
#define KEY_ID_IN_BUILTIN_RANGE(id) 0
#endif
/* Range of file UIDs reserved for uses other than storing a key.
* Defined by the TF-PSA-Crypto storage specification
* docs/architecture/mbed-crypto-storage-specification.md */
#define KEY_ID_IN_RESERVED_FILE_ID_RANGE(id) (0xffff0000 <= ((id) & 0xffffffff))
/* Define a key ID that is in none of the recognized ranges and not 0 */
#define KEY_ID_OUTSIDE_DEFINED_RANGES 0x7fffffffu
#define PSA_KEY_STORAGE_MAGIC_HEADER "PSA\0KEY"
#define PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH (sizeof(PSA_KEY_STORAGE_MAGIC_HEADER))
@@ -150,6 +173,12 @@ void key_id_ranges()
} else {
TEST_LE_U(0x7fffefff + 1, PSA_KEY_ID_VOLATILE_MIN);
}
/* Sanity check on test data */
TEST_ASSERT(!KEY_ID_IN_USER_RANGE(KEY_ID_OUTSIDE_DEFINED_RANGES));
TEST_ASSERT(!KEY_ID_IN_VOLATILE_RANGE(KEY_ID_OUTSIDE_DEFINED_RANGES));
TEST_ASSERT(!KEY_ID_IN_BUILTIN_RANGE(KEY_ID_OUTSIDE_DEFINED_RANGES));
TEST_ASSERT(!KEY_ID_IN_RESERVED_FILE_ID_RANGE(KEY_ID_OUTSIDE_DEFINED_RANGES));
}
/* END_CASE */
@@ -374,3 +403,127 @@ exit:
PSA_DONE();
}
/* END_CASE */
/* BEGIN_CASE */
/* Write content to the file that corresponds to the given key ID,
* then attempt to use a key with this ID.
* Depending on the validity of the key ID and storage content,
* this may or may not work.
*/
void load_primed_storage(int32_t owner_id,
int64_t key_id_arg, /* 0..2^32-1 */
data_t *content,
int expected_attributes_status_arg,
int expected_export_status_arg,
int expected_destroy_status_arg)
{
mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make(owner_id, key_id_arg);
/* Storage UID (file name) for the given key ID, following the storage
* specification. */
psa_storage_uid_t uid = (uint64_t) owner_id << 32 | key_id_arg;
psa_status_t expected_attributes_status = expected_attributes_status_arg;
psa_status_t expected_export_status = expected_export_status_arg;
psa_status_t expected_destroy_status = expected_destroy_status_arg;
psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
uint8_t *key_data = NULL;
struct psa_storage_info_t info;
/* Sanity checks on the test data */
/* The test framework doesn't support unsigned types, so check that
* the key ID is in the actual valid range here. */
TEST_LE_U(0, key_id_arg);
TEST_LE_U(key_id_arg, 0xffffffff);
#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
TEST_EQUAL(owner_id, 0);
#endif
PSA_INIT();
#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
defined(MBEDTLS_CTR_DRBG_C) && \
defined(MBEDTLS_CTR_DRBG_USE_PSA_CRYPTO)
/* Skip this test if we happened to pick the volatile key used by the
* PSA RNG, if there is one. */
if (owner_id == 0 && psa_key_id_is_volatile(key_id)) {
if (psa_get_key_attributes(key_id, &attributes) == PSA_SUCCESS) {
mbedtls_test_skip("Volatile key already in use",
__LINE__, __FILE__);
goto exit;
}
}
#endif
/* Prime the storage. */
psa_status_t file_status = psa_its_get_info(uid, &info);
if (uid == 0) {
/* 0 is not a valid file ID, according to the PSA secure storage
* API specification. */
if (file_status == PSA_ERROR_DOES_NOT_EXIST) {
/* Our own partial storage implementation (psa_its_file.c)
* is not compliant, it returns the wrong error code here.
* That's not a problem, just let it go. */
} else {
TEST_EQUAL(file_status, PSA_ERROR_INVALID_ARGUMENT);
}
} else if (KEY_ID_IN_RESERVED_FILE_ID_RANGE(key_id_arg) &&
file_status == PSA_SUCCESS) {
/* The key ID corresponds to a reserved file (e.g. transaction
* log or entropy seed). Don't corrupt that file. */
} else {
TEST_EQUAL(file_status, PSA_ERROR_DOES_NOT_EXIST);
TEST_EQUAL(psa_its_set(uid, content->len, content->x, 0), PSA_SUCCESS);
}
/* Reading attributes should work for any valid key. */
TEST_EQUAL(psa_get_key_attributes(key_id, &attributes),
expected_attributes_status);
if (expected_attributes_status == PSA_SUCCESS) {
/* It's not our job here to validate the attributes, but do
* sanity-check the attributes related to persistence. */
TEST_ASSERT(mbedtls_svc_key_id_equal(key_id,
psa_get_key_id(&attributes)));
TEST_EQUAL(psa_get_key_lifetime(&attributes),
PSA_KEY_LIFETIME_PERSISTENT);
}
/* Exporting should work for a valid key that has export permission. */
/* Allocate enough memory for the key data (assuming the key
* representation in storage is not compressed compared to the
* export format). */
size_t key_data_size = content->len;
size_t key_data_length = SIZE_MAX;
TEST_CALLOC(key_data, key_data_size);
TEST_EQUAL(psa_export_key(key_id,
key_data, key_data_size, &key_data_length),
expected_export_status);
if (expected_export_status == PSA_SUCCESS) {
TEST_ASSERT(key_data_length != 0);
}
/* Assert that the data length is sensible even if export failed.
* This reduces the risk of memory corruption if an application
* doesn't check the return status of export(). */
TEST_LE_U(key_data_length, key_data_size);
/* Destroying the key should work even for malformed content.
* But it should not work for reserved file IDs. */
TEST_EQUAL(psa_destroy_key(key_id), expected_destroy_status);
if (uid == 0) {
/* Invalid file UID. No point in asserting anything about the file. */
} else if (expected_destroy_status == PSA_SUCCESS) {
file_status = psa_its_get_info(uid, &info);
if (key_id_arg == 0) {
/* psa_destroy_key(0) is defined as a no-op, so it should not
* affect the file. */
TEST_EQUAL(file_status, PSA_SUCCESS);
} else {
TEST_EQUAL(file_status, PSA_ERROR_DOES_NOT_EXIST);
}
}
exit:
psa_reset_key_attributes(&attributes);
PSA_DONE();
psa_its_remove(uid);
mbedtls_free(key_data);
}
/* END_CASE */