9 Key management reference

• 9.1 Key attributes
  • 9.1.1 Managing key attributes
    • psa_key_attributes_t (typedef)
    • PSA_KEY_ATTRIBUTES_INIT (macro)
    • psa_key_attributes_init (function)
    • psa_get_key_attributes (function)
    • psa_reset_key_attributes (function)
• 9.2 Key types
  • 9.2.1 Key type encoding
    • psa_key_type_t (typedef)
    • PSA_KEY_TYPE_NONE (macro)
  • 9.2.2 Key categories
    • PSA_KEY_TYPE_IS_UNSTRUCTURED (macro)
    • PSA_KEY_TYPE_IS_ASYMMETRIC (macro)
    • PSA_KEY_TYPE_IS_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_KEY_PAIR (macro)
  • 9.2.3 Elliptic curve families
    • psa_ecc_family_t (typedef)
    • PSA_ECC_FAMILY_SECP_K1 (macro)
    • PSA_ECC_FAMILY_SECP_R1 (macro)
    • PSA_ECC_FAMILY_SECP_R2 (macro)
    • PSA_ECC_FAMILY_SECT_K1 (macro)
    • PSA_ECC_FAMILY_SECT_R1 (macro)
    • PSA_ECC_FAMILY_SECT_R2 (macro)
    • PSA_ECC_FAMILY_BRAINPOOL_P_R1 (macro)
    • PSA_ECC_FAMILY_FRP (macro)
    • PSA_ECC_FAMILY_MONTGOMERY (macro)
    • PSA_ECC_FAMILY_TWISTED_EDWARDS (macro)
  • 9.2.4 Finite field Diffie-Hellman families
    • psa_dh_family_t (typedef)
    • PSA_DH_FAMILY_RFC7919 (macro)
    • PSA_DH_FAMILY_RFC3526 (macro)
  • 9.2.5 Attribute accessors
    • psa_set_key_type (function)
    • psa_get_key_type (function)
    • psa_get_key_bits (function)
    • psa_set_key_bits (function)
• 9.3 Unstructured key types
  • 9.3.1 Non-key data
    • PSA_KEY_TYPE_RAW_DATA (macro)
    • PSA_KEY_TYPE_DERIVE (macro)
    • PSA_KEY_TYPE_PASSWORD (macro)
    • PSA_KEY_TYPE_PASSWORD_HASH (macro)
    • PSA_KEY_TYPE_PEPPER (macro)
  • 9.3.2 Symmetric cryptographic keys
    • PSA_KEY_TYPE_HMAC (macro)
    • PSA_KEY_TYPE_AES (macro)
    • PSA_KEY_TYPE_ARIA (macro)
    • PSA_KEY_TYPE_DES (macro)
    • PSA_KEY_TYPE_CAMELLIA (macro)
    • PSA_KEY_TYPE_SM4 (macro)
    • PSA_KEY_TYPE_ARC4 (macro)
    • PSA_KEY_TYPE_CHACHA20 (macro)
    • PSA_KEY_TYPE_XCHACHA20 (macro)
    • PSA_KEY_TYPE_ASCON (macro)
• 9.4 Structured key types
  • 9.4.1 WPA3-SAE password tokens
    • PSA_KEY_TYPE_WPA3_SAE_ECC (macro)
    • PSA_KEY_TYPE_WPA3_SAE_DH (macro)
    • PSA_KEY_TYPE_IS_WPA3_SAE_ECC (macro)
    • PSA_KEY_TYPE_WPA3_SAE_ECC_GET_FAMILY (macro)
    • PSA_KEY_TYPE_IS_WPA3_SAE_DH (macro)
    • PSA_KEY_TYPE_WPA3_SAE_DH_GET_FAMILY (macro)
• 9.5 Asymmetric key types
  • 9.5.1 RSA keys
    • PSA_KEY_TYPE_RSA_KEY_PAIR (macro)
    • PSA_KEY_TYPE_RSA_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_RSA (macro)
  • 9.5.2 Elliptic Curve keys
    • PSA_KEY_TYPE_ECC_KEY_PAIR (macro)
    • PSA_KEY_TYPE_ECC_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_ECC (macro)
    • PSA_KEY_TYPE_IS_ECC_KEY_PAIR (macro)
    • PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_ECC_GET_FAMILY (macro)
  • 9.5.3 Diffie Hellman keys
    • PSA_KEY_TYPE_DH_KEY_PAIR (macro)
    • PSA_KEY_TYPE_DH_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_DH (macro)
    • PSA_KEY_TYPE_IS_DH_KEY_PAIR (macro)
    • PSA_KEY_TYPE_IS_DH_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_DH_GET_FAMILY (macro)
  • 9.5.4 SPAKE2+ keys
    • PSA_KEY_TYPE_SPAKE2P_KEY_PAIR (macro)
    • PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_SPAKE2P (macro)
    • PSA_KEY_TYPE_IS_SPAKE2P_KEY_PAIR (macro)
    • PSA_KEY_TYPE_IS_SPAKE2P_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_SPAKE2P_GET_FAMILY (macro)
  • 9.5.5 Support macros
    • PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR (macro)
• 9.6 Key lifetimes
  • 9.6.1 Volatile keys
  • 9.6.2 Persistent keys
  • 9.6.3 Key lifetime encoding
    • psa_key_lifetime_t (typedef)
    • psa_key_persistence_t (typedef)
    • psa_key_location_t (typedef)
  • 9.6.4 Lifetime values
    • PSA_KEY_LIFETIME_VOLATILE (macro)
    • PSA_KEY_LIFETIME_PERSISTENT (macro)
    • PSA_KEY_PERSISTENCE_VOLATILE (macro)
    • PSA_KEY_PERSISTENCE_DEFAULT (macro)
    • PSA_KEY_PERSISTENCE_READ_ONLY (macro)
    • PSA_KEY_LOCATION_LOCAL_STORAGE (macro)
    • PSA_KEY_LOCATION_PRIMARY_SECURE_ELEMENT (macro)
  • 9.6.5 Attribute accessors
    • psa_set_key_lifetime (function)
    • psa_get_key_lifetime (function)
  • 9.6.6 Support macros
    • PSA_KEY_LIFETIME_GET_PERSISTENCE (macro)
    • PSA_KEY_LIFETIME_GET_LOCATION (macro)
    • PSA_KEY_LIFETIME_IS_VOLATILE (macro)
    • PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION (macro)
• 9.7 Key identifiers
  • 9.7.1 Key identifier type
    • psa_key_id_t (typedef)
    • PSA_KEY_ID_NULL (macro)
    • PSA_KEY_ID_USER_MIN (macro)
    • PSA_KEY_ID_USER_MAX (macro)
    • PSA_KEY_ID_VENDOR_MIN (macro)
    • PSA_KEY_ID_VENDOR_MAX (macro)
  • 9.7.2 Attribute accessors
    • psa_set_key_id (function)
    • psa_get_key_id (function)
• 9.8 Key policies
  • 9.8.1 Permitted algorithms
    • psa_set_key_algorithm (function)
    • psa_get_key_algorithm (function)
  • 9.8.2 Key usage flags
    • psa_key_usage_t (typedef)
    • PSA_KEY_USAGE_EXPORT (macro)
    • PSA_KEY_USAGE_COPY (macro)
    • PSA_KEY_USAGE_CACHE (macro)
    • PSA_KEY_USAGE_ENCRYPT (macro)
    • PSA_KEY_USAGE_DECRYPT (macro)
    • PSA_KEY_USAGE_SIGN_MESSAGE (macro)
    • PSA_KEY_USAGE_VERIFY_MESSAGE (macro)
    • PSA_KEY_USAGE_SIGN_HASH (macro)
    • PSA_KEY_USAGE_VERIFY_HASH (macro)
    • PSA_KEY_USAGE_DERIVE (macro)
    • PSA_KEY_USAGE_VERIFY_DERIVATION (macro)
    • PSA_KEY_USAGE_DERIVE_PUBLIC (macro)
    • PSA_KEY_USAGE_WRAP (macro)
    • PSA_KEY_USAGE_UNWRAP (macro)
    • psa_set_key_usage_flags (function)
    • psa_get_key_usage_flags (function)
    • psa_check_key_usage (function)
• 9.9 Key management functions
  • 9.9.1 Key creation
    • psa_import_key (function)
    • psa_custom_key_parameters_t (struct)
    • PSA_CUSTOM_KEY_PARAMETERS_INIT (macro)
    • psa_generate_key (function)
    • psa_generate_key_custom (function)
    • psa_copy_key (function)
    • psa_attach_key (function)
  • 9.9.2 Key destruction
    • psa_destroy_key (function)
    • psa_purge_key (function)
  • 9.9.3 Key export
    • psa_export_key (function)
    • psa_export_public_key (function)
    • PSA_EXPORT_KEY_OUTPUT_SIZE (macro)
    • PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE (macro)
    • PSA_EXPORT_KEY_PAIR_MAX_SIZE (macro)
    • PSA_EXPORT_PUBLIC_KEY_MAX_SIZE (macro)
    • PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE (macro)