10. Cryptographic operation reference

• 10.1. Algorithms
  • 10.1.1. Algorithm encoding
    • psa_algorithm_t (type)
    • PSA_ALG_NONE (macro)
  • 10.1.2. Algorithm categories
    • PSA_ALG_IS_HASH (macro)
    • PSA_ALG_IS_MAC (macro)
    • PSA_ALG_IS_CIPHER (macro)
    • PSA_ALG_IS_AEAD (macro)
    • PSA_ALG_IS_SIGN (macro)
    • PSA_ALG_IS_ASYMMETRIC_ENCRYPTION (macro)
    • PSA_ALG_IS_KEY_AGREEMENT (macro)
    • PSA_ALG_IS_KEY_DERIVATION (macro)
    • PSA_ALG_IS_WILDCARD (macro)
    • PSA_ALG_GET_HASH (macro)
• 10.2. Message digests
  • 10.2.1. Hash algorithms
    • PSA_ALG_MD2 (macro)
    • PSA_ALG_MD4 (macro)
    • PSA_ALG_MD5 (macro)
    • PSA_ALG_RIPEMD160 (macro)
    • PSA_ALG_SHA_1 (macro)
    • PSA_ALG_SHA_224 (macro)
    • PSA_ALG_SHA_256 (macro)
    • PSA_ALG_SHA_384 (macro)
    • PSA_ALG_SHA_512 (macro)
    • PSA_ALG_SHA_512_224 (macro)
    • PSA_ALG_SHA_512_256 (macro)
    • PSA_ALG_SHA3_224 (macro)
    • PSA_ALG_SHA3_256 (macro)
    • PSA_ALG_SHA3_384 (macro)
    • PSA_ALG_SHA3_512 (macro)
    • PSA_ALG_SM3 (macro)
  • 10.2.2. Single-part hashing functions
    • psa_hash_compute (function)
    • psa_hash_compare (function)
  • 10.2.3. Multi-part hashing operations
    • psa_hash_operation_t (type)
    • PSA_HASH_OPERATION_INIT (macro)
    • psa_hash_operation_init (function)
    • psa_hash_setup (function)
    • psa_hash_update (function)
    • psa_hash_finish (function)
    • psa_hash_verify (function)
    • psa_hash_abort (function)
    • psa_hash_suspend (function)
    • psa_hash_resume (function)
    • psa_hash_clone (function)
  • 10.2.4. Support macros
    • PSA_HASH_LENGTH (macro)
    • PSA_HASH_MAX_SIZE (macro)
    • PSA_HASH_SUSPEND_OUTPUT_SIZE (macro)
    • PSA_HASH_SUSPEND_OUTPUT_MAX_SIZE (macro)
    • PSA_HASH_SUSPEND_ALGORITHM_FIELD_LENGTH (macro)
    • PSA_HASH_SUSPEND_INPUT_LENGTH_FIELD_LENGTH (macro)
    • PSA_HASH_SUSPEND_HASH_STATE_FIELD_LENGTH (macro)
    • PSA_HASH_BLOCK_LENGTH (macro)
  • 10.2.5. Hash suspend state
    • Hash suspend state format
    • Hash suspend state field sizes
• 10.3. Message authentication codes (MAC)
  • 10.3.1. MAC algorithms
    • PSA_ALG_HMAC (macro)
    • PSA_ALG_TRUNCATED_MAC (macro)
    • PSA_ALG_CBC_MAC (macro)
    • PSA_ALG_CMAC (macro)
  • 10.3.2. Single-part MAC functions
    • psa_mac_compute (function)
    • psa_mac_verify (function)
  • 10.3.3. Multi-part MAC operations
    • psa_mac_operation_t (type)
    • PSA_MAC_OPERATION_INIT (macro)
    • psa_mac_operation_init (function)
    • psa_mac_sign_setup (function)
    • psa_mac_verify_setup (function)
    • psa_mac_update (function)
    • psa_mac_sign_finish (function)
    • psa_mac_verify_finish (function)
    • psa_mac_abort (function)
  • 10.3.4. Support macros
    • PSA_ALG_IS_HMAC (macro)
    • PSA_ALG_IS_BLOCK_CIPHER_MAC (macro)
    • PSA_ALG_FULL_LENGTH_MAC (macro)
    • PSA_MAC_LENGTH (macro)
    • PSA_MAC_MAX_SIZE (macro)
• 10.4. Unauthenticated ciphers
  • 10.4.1. Cipher algorithms
    • PSA_ALG_STREAM_CIPHER (macro)
    • PSA_ALG_CTR (macro)
    • PSA_ALG_CFB (macro)
    • PSA_ALG_OFB (macro)
    • PSA_ALG_XTS (macro)
    • PSA_ALG_ECB_NO_PADDING (macro)
    • PSA_ALG_CBC_NO_PADDING (macro)
    • PSA_ALG_CBC_PKCS7 (macro)
  • 10.4.2. Single-part cipher functions
    • psa_cipher_encrypt (function)
    • psa_cipher_decrypt (function)
  • 10.4.3. Multi-part cipher operations
    • psa_cipher_operation_t (type)
    • PSA_CIPHER_OPERATION_INIT (macro)
    • psa_cipher_operation_init (function)
    • psa_cipher_encrypt_setup (function)
    • psa_cipher_decrypt_setup (function)
    • psa_cipher_generate_iv (function)
    • psa_cipher_set_iv (function)
    • psa_cipher_update (function)
    • psa_cipher_finish (function)
    • psa_cipher_abort (function)
  • 10.4.4. Support macros
    • PSA_ALG_IS_STREAM_CIPHER (macro)
    • PSA_CIPHER_ENCRYPT_OUTPUT_SIZE (macro)
    • PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE (macro)
    • PSA_CIPHER_DECRYPT_OUTPUT_SIZE (macro)
    • PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE (macro)
    • PSA_CIPHER_IV_LENGTH (macro)
    • PSA_CIPHER_IV_MAX_SIZE (macro)
    • PSA_CIPHER_UPDATE_OUTPUT_SIZE (macro)
    • PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE (macro)
    • PSA_CIPHER_FINISH_OUTPUT_SIZE (macro)
    • PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE (macro)
    • PSA_BLOCK_CIPHER_BLOCK_LENGTH (macro)
    • PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE (macro)
• 10.5. Authenticated encryption with associated data (AEAD)
  • 10.5.1. AEAD algorithms
    • PSA_ALG_CCM (macro)
    • PSA_ALG_GCM (macro)
    • PSA_ALG_CHACHA20_POLY1305 (macro)
    • PSA_ALG_AEAD_WITH_SHORTENED_TAG (macro)
  • 10.5.2. Single-part AEAD functions
    • psa_aead_encrypt (function)
    • psa_aead_decrypt (function)
  • 10.5.3. Multi-part AEAD operations
    • psa_aead_operation_t (type)
    • PSA_AEAD_OPERATION_INIT (macro)
    • psa_aead_operation_init (function)
    • psa_aead_encrypt_setup (function)
    • psa_aead_decrypt_setup (function)
    • psa_aead_set_lengths (function)
    • psa_aead_generate_nonce (function)
    • psa_aead_set_nonce (function)
    • psa_aead_update_ad (function)
    • psa_aead_update (function)
    • psa_aead_finish (function)
    • psa_aead_verify (function)
    • psa_aead_abort (function)
  • 10.5.4. Support macros
    • PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER (macro)
    • PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG (macro)
    • PSA_AEAD_ENCRYPT_OUTPUT_SIZE (macro)
    • PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE (macro)
    • PSA_AEAD_DECRYPT_OUTPUT_SIZE (macro)
    • PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE (macro)
    • PSA_AEAD_NONCE_LENGTH (macro)
    • PSA_AEAD_NONCE_MAX_SIZE (macro)
    • PSA_AEAD_UPDATE_OUTPUT_SIZE (macro)
    • PSA_AEAD_UPDATE_OUTPUT_MAX_SIZE (macro)
    • PSA_AEAD_FINISH_OUTPUT_SIZE (macro)
    • PSA_AEAD_FINISH_OUTPUT_MAX_SIZE (macro)
    • PSA_AEAD_TAG_LENGTH (macro)
    • PSA_AEAD_TAG_MAX_SIZE (macro)
    • PSA_AEAD_VERIFY_OUTPUT_SIZE (macro)
    • PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE (macro)
• 10.6. Key derivation
  • 10.6.1. Key derivation algorithms
    • PSA_ALG_HKDF (macro)
    • PSA_ALG_TLS12_PRF (macro)
    • PSA_ALG_TLS12_PSK_TO_MS (macro)
  • 10.6.2. Input step types
    • psa_key_derivation_step_t (type)
    • PSA_KEY_DERIVATION_INPUT_SECRET (macro)
    • PSA_KEY_DERIVATION_INPUT_LABEL (macro)
    • PSA_KEY_DERIVATION_INPUT_CONTEXT (macro)
    • PSA_KEY_DERIVATION_INPUT_SALT (macro)
    • PSA_KEY_DERIVATION_INPUT_INFO (macro)
    • PSA_KEY_DERIVATION_INPUT_SEED (macro)
  • 10.6.3. Key derivation functions
    • psa_key_derivation_operation_t (type)
    • PSA_KEY_DERIVATION_OPERATION_INIT (macro)
    • psa_key_derivation_operation_init (function)
    • psa_key_derivation_setup (function)
    • psa_key_derivation_get_capacity (function)
    • psa_key_derivation_set_capacity (function)
    • psa_key_derivation_input_bytes (function)
    • psa_key_derivation_input_key (function)
    • psa_key_derivation_output_bytes (function)
    • psa_key_derivation_output_key (function)
    • psa_key_derivation_abort (function)
  • 10.6.4. Support macros
    • PSA_ALG_IS_HKDF (macro)
    • PSA_ALG_IS_TLS12_PRF (macro)
    • PSA_ALG_IS_TLS12_PSK_TO_MS (macro)
    • PSA_KEY_DERIVATION_UNLIMITED_CAPACITY (macro)
    • PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE (macro)
• 10.7. Asymmetric signature
  • 10.7.1. Asymmetric signature algorithms
    • PSA_ALG_RSA_PKCS1V15_SIGN (macro)
    • PSA_ALG_RSA_PKCS1V15_SIGN_RAW (macro)
    • PSA_ALG_RSA_PSS (macro)
    • PSA_ALG_ECDSA (macro)
    • PSA_ALG_ECDSA_ANY (macro)
    • PSA_ALG_DETERMINISTIC_ECDSA (macro)
  • 10.7.2. Asymmetric signature functions
    • psa_sign_message (function)
    • psa_verify_message (function)
    • psa_sign_hash (function)
    • psa_verify_hash (function)
  • 10.7.3. Support macros
    • PSA_ALG_IS_SIGN_MESSAGE (macro)
    • PSA_ALG_IS_SIGN_HASH (macro)
    • PSA_ALG_IS_RSA_PKCS1V15_SIGN (macro)
    • PSA_ALG_IS_RSA_PSS (macro)
    • PSA_ALG_IS_ECDSA (macro)
    • PSA_ALG_IS_DETERMINISTIC_ECDSA (macro)
    • PSA_ALG_IS_RANDOMIZED_ECDSA (macro)
    • PSA_ALG_IS_HASH_AND_SIGN (macro)
    • PSA_ALG_ANY_HASH (macro)
    • PSA_SIGN_OUTPUT_SIZE (macro)
    • PSA_SIGNATURE_MAX_SIZE (macro)
• 10.8. Asymmetric encryption
  • 10.8.1. Asymmetric encryption algorithms
    • PSA_ALG_RSA_PKCS1V15_CRYPT (macro)
    • PSA_ALG_RSA_OAEP (macro)
  • 10.8.2. Asymmetric encryption functions
    • psa_asymmetric_encrypt (function)
    • psa_asymmetric_decrypt (function)
  • 10.8.3. Support macros
    • PSA_ALG_IS_RSA_OAEP (macro)
    • PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE (macro)
    • PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE (macro)
    • PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE (macro)
    • PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE (macro)
• 10.9. Key agreement
  • 10.9.1. Key agreement algorithms
    • PSA_ALG_KEY_AGREEMENT (macro)
    • PSA_ALG_FFDH (macro)
    • PSA_ALG_ECDH (macro)
  • 10.9.2. Standalone key agreement
    • psa_raw_key_agreement (function)
  • 10.9.3. Combining key agreement and key derivation
    • psa_key_derivation_key_agreement (function)
  • 10.9.4. Support macros
    • PSA_ALG_KEY_AGREEMENT_GET_BASE (macro)
    • PSA_ALG_KEY_AGREEMENT_GET_KDF (macro)
    • PSA_ALG_IS_RAW_KEY_AGREEMENT (macro)
    • PSA_ALG_IS_FFDH (macro)
    • PSA_ALG_IS_ECDH (macro)
    • PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE (macro)
    • PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE (macro)
• 10.10. Other cryptographic services
  • 10.10.1. Random number generation
    • psa_generate_random (function)