Beta

2 API Reference

Note

The API defined in this specification will be integrated into a future version of [PSA-CRYPT].

This chapter is divided into sections for each of the PQC algorithms in the Crypto API:

• 2.1 Additional Hash algorithms
  • 2.1.1 SHA-256-based hash algorithms
    • PSA_ALG_SHA_256_192 (macro)
  • 2.1.2 SHAKE-based hash algorithms
    • PSA_ALG_SHAKE128_256 (macro)
    • PSA_ALG_SHAKE256_192 (macro)
    • PSA_ALG_SHAKE256_256 (macro)
• 2.2 Module Lattice-based key encapsulation
  • 2.2.1 Module Lattice-based key-encapsulation keys
    • PSA_KEY_TYPE_ML_KEM_KEY_PAIR (macro)
    • PSA_KEY_TYPE_ML_KEM_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_ML_KEM (macro)
  • 2.2.2 Module Lattice-based key-encapsulation algorithm
    • PSA_ALG_ML_KEM (macro)
• 2.3 Module Lattice-based signatures
  • 2.3.1 Module Lattice-based signature keys
    • PSA_KEY_TYPE_ML_DSA_KEY_PAIR (macro)
    • PSA_KEY_TYPE_ML_DSA_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_IS_ML_DSA (macro)
  • 2.3.2 Module Lattice-based signature algorithms
    • PSA_ALG_ML_DSA (macro)
    • PSA_ALG_DETERMINISTIC_ML_DSA (macro)
    • PSA_ALG_HASH_ML_DSA (macro)
    • PSA_ALG_DETERMINISTIC_HASH_ML_DSA (macro)
    • PSA_ALG_IS_ML_DSA (macro)
    • PSA_ALG_IS_HASH_ML_DSA (macro)
    • PSA_ALG_IS_DETERMINISTIC_HASH_ML_DSA (macro)
    • PSA_ALG_IS_HEDGED_HASH_ML_DSA (macro)
• 2.4 Stateless Hash-based signatures
  • 2.4.1 Stateless Hash-based signature keys
    • psa_slh_dsa_family_t (typedef)
    • PSA_KEY_TYPE_SLH_DSA_KEY_PAIR (macro)
    • PSA_KEY_TYPE_SLH_DSA_PUBLIC_KEY (macro)
    • PSA_SLH_DSA_FAMILY_SHA2_S (macro)
    • PSA_SLH_DSA_FAMILY_SHA2_F (macro)
    • PSA_SLH_DSA_FAMILY_SHAKE_S (macro)
    • PSA_SLH_DSA_FAMILY_SHAKE_F (macro)
    • PSA_KEY_TYPE_IS_SLH_DSA (macro)
    • PSA_KEY_TYPE_IS_SLH_DSA_KEY_PAIR (macro)
    • PSA_KEY_TYPE_IS_SLH_DSA_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_SLH_DSA_GET_FAMILY (macro)
  • 2.4.2 Stateless Hash-based signature algorithms
    • PSA_ALG_SLH_DSA (macro)
    • PSA_ALG_DETERMINISTIC_SLH_DSA (macro)
    • PSA_ALG_HASH_SLH_DSA (macro)
    • PSA_ALG_DETERMINISTIC_HASH_SLH_DSA (macro)
    • PSA_ALG_IS_SLH_DSA (macro)
    • PSA_ALG_IS_HASH_SLH_DSA (macro)
    • PSA_ALG_IS_DETERMINISTIC_HASH_SLH_DSA (macro)
    • PSA_ALG_IS_HEDGED_HASH_SLH_DSA (macro)
• 2.5 Leighton-Micali Signatures
  • 2.5.1 Leighton-Micali Signature keys
    • PSA_KEY_TYPE_LMS_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_HSS_PUBLIC_KEY (macro)
  • 2.5.2 Leighton-Micali Signature algorithms
    • PSA_ALG_LMS (macro)
    • PSA_ALG_HSS (macro)
• 2.6 eXtended Merkle Signature Scheme
  • 2.6.1 XMSS and XMSS^MT keys
    • PSA_KEY_TYPE_XMSS_PUBLIC_KEY (macro)
    • PSA_KEY_TYPE_XMSS_MT_PUBLIC_KEY (macro)
  • 2.6.2 XMSS and XMSS^MT algorithms
    • PSA_ALG_XMSS (macro)
    • PSA_ALG_XMSS_MT (macro)

See Algorithm and key type encoding for the encoding of the key types and algorithm identifiers added by this extension.