From aff1181d671f09315a549f80616b0ae8877f1109 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 4 May 2020 19:03:10 +0200 Subject: [PATCH] Document PSA_KEY_PERSISTENCE_xxx and PSA_KEY_LOCATION_xxx Signed-off-by: Gilles Peskine --- include/psa/crypto_values.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/include/psa/crypto_values.h b/include/psa/crypto_values.h index 48e085c08..ee125ab4c 100644 --- a/include/psa/crypto_values.h +++ b/include/psa/crypto_values.h @@ -1567,8 +1567,22 @@ */ #define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t)0x00000001) +/** The persistence level of volatile keys. + * + * See ::psa_key_persistence_t for more information. + */ #define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t)0x00) + +/** The default persistence level for persistent keys. + * + * See ::psa_key_persistence_t for more information. + */ #define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t)0x01) + +/** A persistence level indicating that a key is never destroyed. + * + * See ::psa_key_persistence_t for more information. + */ #define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t)0xff) #define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \ @@ -1597,7 +1611,15 @@ (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \ PSA_KEY_LIFETIME_PERSISTENCE_VOLATILE) +/** The local storage area for persistent keys. + * + * This storage area is available on all systems that can store persistent + * keys without delegating the storage to a third-party cryptoprocessor. + * + * See ::psa_key_location_t for more information. + */ #define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t)0x000000) + #define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t)0x800000) /** The minimum value for a key identifier chosen by the application.