NCBI C++ ToolKit
Macros | Typedefs
Key and algorithm types

Macros

#define PSA_KEY_TYPE_DSA_PUBLIC_KEY   ((psa_key_type_t) 0x4002)
 DSA public key. More...
 
#define PSA_KEY_TYPE_DSA_KEY_PAIR   ((psa_key_type_t) 0x7002)
 DSA key pair (private and public key). More...
 
#define PSA_KEY_TYPE_IS_DSA(type)    (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_DSA_PUBLIC_KEY)
 Whether a key type is a DSA key (pair or public-only). More...
 
#define PSA_ALG_DSA_BASE   ((psa_algorithm_t) 0x06000400)
 
#define PSA_ALG_DSA(hash_alg)    (PSA_ALG_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 DSA signature with hashing. More...
 
#define PSA_ALG_DETERMINISTIC_DSA_BASE   ((psa_algorithm_t) 0x06000500)
 
#define PSA_ALG_DSA_DETERMINISTIC_FLAG   PSA_ALG_ECDSA_DETERMINISTIC_FLAG
 
#define PSA_ALG_DETERMINISTIC_DSA(hash_alg)    (PSA_ALG_DETERMINISTIC_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Deterministic DSA signature with hashing. More...
 
#define PSA_ALG_IS_DSA(alg)
 
#define PSA_ALG_DSA_IS_DETERMINISTIC(alg)    (((alg) & PSA_ALG_DSA_DETERMINISTIC_FLAG) != 0)
 
#define PSA_ALG_IS_DETERMINISTIC_DSA(alg)    (PSA_ALG_IS_DSA(alg) && PSA_ALG_DSA_IS_DETERMINISTIC(alg))
 
#define PSA_ALG_IS_RANDOMIZED_DSA(alg)    (PSA_ALG_IS_DSA(alg) && !PSA_ALG_DSA_IS_DETERMINISTIC(alg))
 
#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg)    PSA_ALG_IS_DSA(alg)
 
#define PSA_KEY_TYPE_NONE   ((psa_key_type_t) 0x0000)
 An invalid key type value. More...
 
#define PSA_KEY_TYPE_VENDOR_FLAG   ((psa_key_type_t) 0x8000)
 Vendor-defined key type flag. More...
 
#define PSA_KEY_TYPE_CATEGORY_MASK   ((psa_key_type_t) 0x7000)
 
#define PSA_KEY_TYPE_CATEGORY_RAW   ((psa_key_type_t) 0x1000)
 
#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC   ((psa_key_type_t) 0x2000)
 
#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY   ((psa_key_type_t) 0x4000)
 
#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR   ((psa_key_type_t) 0x7000)
 
#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR   ((psa_key_type_t) 0x3000)
 
#define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type)    (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
 Whether a key type is vendor-defined. More...
 
#define PSA_KEY_TYPE_IS_UNSTRUCTURED(type)
 Whether a key type is an unstructured array of bytes. More...
 
#define PSA_KEY_TYPE_IS_ASYMMETRIC(type)
 Whether a key type is asymmetric: either a key pair or a public key. More...
 
#define PSA_KEY_TYPE_IS_PUBLIC_KEY(type)    (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
 Whether a key type is the public part of a key pair. More...
 
#define PSA_KEY_TYPE_IS_KEY_PAIR(type)    (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
 Whether a key type is a key pair containing a private part and a public part. More...
 
#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type)    ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
 The key pair type corresponding to a public key type. More...
 
#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type)    ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
 The public key type corresponding to a key pair type. More...
 
#define PSA_KEY_TYPE_RAW_DATA   ((psa_key_type_t) 0x1001)
 Raw data. More...
 
#define PSA_KEY_TYPE_HMAC   ((psa_key_type_t) 0x1100)
 HMAC key. More...
 
#define PSA_KEY_TYPE_DERIVE   ((psa_key_type_t) 0x1200)
 A secret for key derivation. More...
 
#define PSA_KEY_TYPE_AES   ((psa_key_type_t) 0x2400)
 Key for a cipher, AEAD or MAC algorithm based on the AES block cipher. More...
 
#define PSA_KEY_TYPE_ARIA   ((psa_key_type_t) 0x2406)
 Key for a cipher, AEAD or MAC algorithm based on the ARIA block cipher. More...
 
#define PSA_KEY_TYPE_DES   ((psa_key_type_t) 0x2301)
 Key for a cipher or MAC algorithm based on DES or 3DES (Triple-DES). More...
 
#define PSA_KEY_TYPE_CAMELLIA   ((psa_key_type_t) 0x2403)
 Key for a cipher, AEAD or MAC algorithm based on the Camellia block cipher. More...
 
#define PSA_KEY_TYPE_ARC4   ((psa_key_type_t) 0x2002)
 Key for the ARC4 stream cipher (also known as RC4 or ARCFOUR). More...
 
#define PSA_KEY_TYPE_CHACHA20   ((psa_key_type_t) 0x2004)
 Key for the ChaCha20 stream cipher or the Chacha20-Poly1305 AEAD algorithm. More...
 
#define PSA_KEY_TYPE_RSA_PUBLIC_KEY   ((psa_key_type_t) 0x4001)
 RSA public key. More...
 
#define PSA_KEY_TYPE_RSA_KEY_PAIR   ((psa_key_type_t) 0x7001)
 RSA key pair (private and public key). More...
 
#define PSA_KEY_TYPE_IS_RSA(type)    (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
 Whether a key type is an RSA key (pair or public-only). More...
 
#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE   ((psa_key_type_t) 0x4100)
 
#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE   ((psa_key_type_t) 0x7100)
 
#define PSA_KEY_TYPE_ECC_CURVE_MASK   ((psa_key_type_t) 0x00ff)
 
#define PSA_KEY_TYPE_ECC_KEY_PAIR(curve)    (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
 Elliptic curve key pair. More...
 
#define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve)    (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
 Elliptic curve public key. More...
 
#define PSA_KEY_TYPE_IS_ECC(type)
 Whether a key type is an elliptic curve key (pair or public-only). More...
 
#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type)
 Whether a key type is an elliptic curve key pair. More...
 
#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type)
 Whether a key type is an elliptic curve public key. More...
 
#define PSA_KEY_TYPE_ECC_GET_FAMILY(type)
 Extract the curve from an elliptic curve key type. More...
 
#define PSA_ECC_FAMILY_SECP_K1   ((psa_ecc_family_t) 0x17)
 SEC Koblitz curves over prime fields. More...
 
#define PSA_ECC_FAMILY_SECP_R1   ((psa_ecc_family_t) 0x12)
 SEC random curves over prime fields. More...
 
#define PSA_ECC_FAMILY_SECP_R2   ((psa_ecc_family_t) 0x1b)
 
#define PSA_ECC_FAMILY_SECT_K1   ((psa_ecc_family_t) 0x27)
 SEC Koblitz curves over binary fields. More...
 
#define PSA_ECC_FAMILY_SECT_R1   ((psa_ecc_family_t) 0x22)
 SEC random curves over binary fields. More...
 
#define PSA_ECC_FAMILY_SECT_R2   ((psa_ecc_family_t) 0x2b)
 SEC additional random curves over binary fields. More...
 
#define PSA_ECC_FAMILY_BRAINPOOL_P_R1   ((psa_ecc_family_t) 0x30)
 Brainpool P random curves. More...
 
#define PSA_ECC_FAMILY_MONTGOMERY   ((psa_ecc_family_t) 0x41)
 Curve25519 and Curve448. More...
 
#define PSA_ECC_FAMILY_TWISTED_EDWARDS   ((psa_ecc_family_t) 0x42)
 The twisted Edwards curves Ed25519 and Ed448. More...
 
#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE   ((psa_key_type_t) 0x4200)
 
#define PSA_KEY_TYPE_DH_KEY_PAIR_BASE   ((psa_key_type_t) 0x7200)
 
#define PSA_KEY_TYPE_DH_GROUP_MASK   ((psa_key_type_t) 0x00ff)
 
#define PSA_KEY_TYPE_DH_KEY_PAIR(group)    (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
 Diffie-Hellman key pair. More...
 
#define PSA_KEY_TYPE_DH_PUBLIC_KEY(group)    (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
 Diffie-Hellman public key. More...
 
#define PSA_KEY_TYPE_IS_DH(type)
 Whether a key type is a Diffie-Hellman key (pair or public-only). More...
 
#define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type)
 Whether a key type is a Diffie-Hellman key pair. More...
 
#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type)
 Whether a key type is a Diffie-Hellman public key. More...
 
#define PSA_KEY_TYPE_DH_GET_FAMILY(type)
 Extract the group from a Diffie-Hellman key type. More...
 
#define PSA_DH_FAMILY_RFC7919   ((psa_dh_family_t) 0x03)
 Diffie-Hellman groups defined in RFC 7919 Appendix A. More...
 
#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type)    (((type) >> 8) & 7)
 
#define PSA_BLOCK_CIPHER_BLOCK_LENGTH(type)
 The block size of a block cipher. More...
 
#define PSA_ALG_VENDOR_FLAG   ((psa_algorithm_t) 0x80000000)
 Vendor-defined algorithm flag. More...
 
#define PSA_ALG_CATEGORY_MASK   ((psa_algorithm_t) 0x7f000000)
 
#define PSA_ALG_CATEGORY_HASH   ((psa_algorithm_t) 0x02000000)
 
#define PSA_ALG_CATEGORY_MAC   ((psa_algorithm_t) 0x03000000)
 
#define PSA_ALG_CATEGORY_CIPHER   ((psa_algorithm_t) 0x04000000)
 
#define PSA_ALG_CATEGORY_AEAD   ((psa_algorithm_t) 0x05000000)
 
#define PSA_ALG_CATEGORY_SIGN   ((psa_algorithm_t) 0x06000000)
 
#define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION   ((psa_algorithm_t) 0x07000000)
 
#define PSA_ALG_CATEGORY_KEY_DERIVATION   ((psa_algorithm_t) 0x08000000)
 
#define PSA_ALG_CATEGORY_KEY_AGREEMENT   ((psa_algorithm_t) 0x09000000)
 
#define PSA_ALG_IS_VENDOR_DEFINED(alg)    (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
 Whether an algorithm is vendor-defined. More...
 
#define PSA_ALG_IS_HASH(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
 Whether the specified algorithm is a hash algorithm. More...
 
#define PSA_ALG_IS_MAC(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
 Whether the specified algorithm is a MAC algorithm. More...
 
#define PSA_ALG_IS_CIPHER(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
 Whether the specified algorithm is a symmetric cipher algorithm. More...
 
#define PSA_ALG_IS_AEAD(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
 Whether the specified algorithm is an authenticated encryption with associated data (AEAD) algorithm. More...
 
#define PSA_ALG_IS_SIGN(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
 Whether the specified algorithm is an asymmetric signature algorithm, also known as public-key signature algorithm. More...
 
#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
 Whether the specified algorithm is an asymmetric encryption algorithm, also known as public-key encryption algorithm. More...
 
#define PSA_ALG_IS_KEY_AGREEMENT(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
 Whether the specified algorithm is a key agreement algorithm. More...
 
#define PSA_ALG_IS_KEY_DERIVATION(alg)    (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
 Whether the specified algorithm is a key derivation algorithm. More...
 
#define PSA_ALG_NONE   ((psa_algorithm_t)0)
 An invalid algorithm identifier value. More...
 
#define PSA_ALG_HASH_MASK   ((psa_algorithm_t) 0x000000ff)
 
#define PSA_ALG_MD2   ((psa_algorithm_t) 0x02000001)
 MD2. More...
 
#define PSA_ALG_MD4   ((psa_algorithm_t) 0x02000002)
 MD4. More...
 
#define PSA_ALG_MD5   ((psa_algorithm_t) 0x02000003)
 MD5. More...
 
#define PSA_ALG_RIPEMD160   ((psa_algorithm_t) 0x02000004)
 PSA_ALG_RIPEMD160. More...
 
#define PSA_ALG_SHA_1   ((psa_algorithm_t) 0x02000005)
 SHA1. More...
 
#define PSA_ALG_SHA_224   ((psa_algorithm_t) 0x02000008)
 SHA2-224. More...
 
#define PSA_ALG_SHA_256   ((psa_algorithm_t) 0x02000009)
 SHA2-256. More...
 
#define PSA_ALG_SHA_384   ((psa_algorithm_t) 0x0200000a)
 SHA2-384. More...
 
#define PSA_ALG_SHA_512   ((psa_algorithm_t) 0x0200000b)
 SHA2-512. More...
 
#define PSA_ALG_SHA_512_224   ((psa_algorithm_t) 0x0200000c)
 SHA2-512/224. More...
 
#define PSA_ALG_SHA_512_256   ((psa_algorithm_t) 0x0200000d)
 SHA2-512/256. More...
 
#define PSA_ALG_SHA3_224   ((psa_algorithm_t) 0x02000010)
 SHA3-224. More...
 
#define PSA_ALG_SHA3_256   ((psa_algorithm_t) 0x02000011)
 SHA3-256. More...
 
#define PSA_ALG_SHA3_384   ((psa_algorithm_t) 0x02000012)
 SHA3-384. More...
 
#define PSA_ALG_SHA3_512   ((psa_algorithm_t) 0x02000013)
 SHA3-512. More...
 
#define PSA_ALG_SHAKE256_512   ((psa_algorithm_t) 0x02000015)
 The first 512 bits (64 bytes) of the SHAKE256 output. More...
 
#define PSA_ALG_ANY_HASH   ((psa_algorithm_t) 0x020000ff)
 In a hash-and-sign algorithm policy, allow any hash algorithm. More...
 
#define PSA_ALG_MAC_SUBCATEGORY_MASK   ((psa_algorithm_t) 0x00c00000)
 
#define PSA_ALG_HMAC_BASE   ((psa_algorithm_t) 0x03800000)
 
#define PSA_ALG_HMAC(hash_alg)    (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Macro to build an HMAC algorithm. More...
 
#define PSA_ALG_HMAC_GET_HASH(hmac_alg)    (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
 
#define PSA_ALG_IS_HMAC(alg)
 Whether the specified algorithm is an HMAC algorithm. More...
 
#define PSA_ALG_MAC_TRUNCATION_MASK   ((psa_algorithm_t) 0x003f0000)
 
#define PSA_MAC_TRUNCATION_OFFSET   16
 
#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG   ((psa_algorithm_t) 0x00008000)
 
#define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length)
 Macro to build a truncated MAC algorithm. More...
 
#define PSA_ALG_FULL_LENGTH_MAC(mac_alg)
 Macro to build the base MAC algorithm corresponding to a truncated MAC algorithm. More...
 
#define PSA_MAC_TRUNCATED_LENGTH(mac_alg)    (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
 Length to which a MAC algorithm is truncated. More...
 
#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(mac_alg, min_mac_length)
 Macro to build a MAC minimum-MAC-length wildcard algorithm. More...
 
#define PSA_ALG_CIPHER_MAC_BASE   ((psa_algorithm_t) 0x03c00000)
 
#define PSA_ALG_CBC_MAC   ((psa_algorithm_t) 0x03c00100)
 The CBC-MAC construction over a block cipher. More...
 
#define PSA_ALG_CMAC   ((psa_algorithm_t) 0x03c00200)
 The CMAC construction over a block cipher. More...
 
#define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg)
 Whether the specified algorithm is a MAC algorithm based on a block cipher. More...
 
#define PSA_ALG_CIPHER_STREAM_FLAG   ((psa_algorithm_t) 0x00800000)
 
#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG   ((psa_algorithm_t) 0x00400000)
 
#define PSA_ALG_IS_STREAM_CIPHER(alg)
 Whether the specified algorithm is a stream cipher. More...
 
#define PSA_ALG_STREAM_CIPHER   ((psa_algorithm_t) 0x04800100)
 The stream cipher mode of a stream cipher algorithm. More...
 
#define PSA_ALG_CTR   ((psa_algorithm_t) 0x04c01000)
 The CTR stream cipher mode. More...
 
#define PSA_ALG_CFB   ((psa_algorithm_t) 0x04c01100)
 The CFB stream cipher mode. More...
 
#define PSA_ALG_OFB   ((psa_algorithm_t) 0x04c01200)
 The OFB stream cipher mode. More...
 
#define PSA_ALG_XTS   ((psa_algorithm_t) 0x0440ff00)
 The XTS cipher mode. More...
 
#define PSA_ALG_ECB_NO_PADDING   ((psa_algorithm_t) 0x04404400)
 The Electronic Code Book (ECB) mode of a block cipher, with no padding. More...
 
#define PSA_ALG_CBC_NO_PADDING   ((psa_algorithm_t) 0x04404000)
 The CBC block cipher chaining mode, with no padding. More...
 
#define PSA_ALG_CBC_PKCS7   ((psa_algorithm_t) 0x04404100)
 The CBC block cipher chaining mode with PKCS#7 padding. More...
 
#define PSA_ALG_AEAD_FROM_BLOCK_FLAG   ((psa_algorithm_t) 0x00400000)
 
#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg)
 Whether the specified algorithm is an AEAD mode on a block cipher. More...
 
#define PSA_ALG_CCM   ((psa_algorithm_t) 0x05500100)
 The CCM authenticated encryption algorithm. More...
 
#define PSA_ALG_GCM   ((psa_algorithm_t) 0x05500200)
 The GCM authenticated encryption algorithm. More...
 
#define PSA_ALG_CHACHA20_POLY1305   ((psa_algorithm_t) 0x05100500)
 The Chacha20-Poly1305 AEAD algorithm. More...
 
#define PSA_ALG_AEAD_TAG_LENGTH_MASK   ((psa_algorithm_t) 0x003f0000)
 
#define PSA_AEAD_TAG_LENGTH_OFFSET   16
 
#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG   ((psa_algorithm_t) 0x00008000)
 
#define PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, tag_length)
 Macro to build a shortened AEAD algorithm. More...
 
#define PSA_ALG_AEAD_GET_TAG_LENGTH(aead_alg)
 Retrieve the tag length of a specified AEAD algorithm. More...
 
#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(aead_alg)
 Calculate the corresponding AEAD algorithm with the default tag length. More...
 
#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, ref)
 
#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(aead_alg, min_tag_length)
 Macro to build an AEAD minimum-tag-length wildcard algorithm. More...
 
#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE   ((psa_algorithm_t) 0x06000200)
 
#define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg)    (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 RSA PKCS#1 v1.5 signature with hashing. More...
 
#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW   PSA_ALG_RSA_PKCS1V15_SIGN_BASE
 Raw PKCS#1 v1.5 signature. More...
 
#define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
 
#define PSA_ALG_RSA_PSS_BASE   ((psa_algorithm_t) 0x06000300)
 
#define PSA_ALG_RSA_PSS_ANY_SALT_BASE   ((psa_algorithm_t) 0x06001300)
 
#define PSA_ALG_RSA_PSS(hash_alg)    (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 RSA PSS signature with hashing. More...
 
#define PSA_ALG_RSA_PSS_ANY_SALT(hash_alg)    (PSA_ALG_RSA_PSS_ANY_SALT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 RSA PSS signature with hashing with relaxed verification. More...
 
#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
 Whether the specified algorithm is RSA PSS with standard salt. More...
 
#define PSA_ALG_IS_RSA_PSS_ANY_SALT(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_ANY_SALT_BASE)
 Whether the specified algorithm is RSA PSS with any salt. More...
 
#define PSA_ALG_IS_RSA_PSS(alg)
 Whether the specified algorithm is RSA PSS. More...
 
#define PSA_ALG_ECDSA_BASE   ((psa_algorithm_t) 0x06000600)
 
#define PSA_ALG_ECDSA(hash_alg)    (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 ECDSA signature with hashing. More...
 
#define PSA_ALG_ECDSA_ANY   PSA_ALG_ECDSA_BASE
 ECDSA signature without hashing. More...
 
#define PSA_ALG_DETERMINISTIC_ECDSA_BASE   ((psa_algorithm_t) 0x06000700)
 
#define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg)    (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Deterministic ECDSA signature with hashing. More...
 
#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG   ((psa_algorithm_t) 0x00000100)
 
#define PSA_ALG_IS_ECDSA(alg)
 
#define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg)    (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
 
#define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg)    (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
 
#define PSA_ALG_IS_RANDOMIZED_ECDSA(alg)    (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
 
#define PSA_ALG_PURE_EDDSA   ((psa_algorithm_t) 0x06000800)
 Edwards-curve digital signature algorithm without prehashing (PureEdDSA), using standard parameters. More...
 
#define PSA_ALG_HASH_EDDSA_BASE   ((psa_algorithm_t) 0x06000900)
 
#define PSA_ALG_IS_HASH_EDDSA(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HASH_EDDSA_BASE)
 
#define PSA_ALG_ED25519PH    (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHA_512 & PSA_ALG_HASH_MASK))
 Edwards-curve digital signature algorithm with prehashing (HashEdDSA), using SHA-512 and the Edwards25519 curve. More...
 
#define PSA_ALG_ED448PH    (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHAKE256_512 & PSA_ALG_HASH_MASK))
 Edwards-curve digital signature algorithm with prehashing (HashEdDSA), using SHAKE256 and the Edwards448 curve. More...
 
#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg)   0
 
#define PSA_ALG_IS_SIGN_HASH(alg)
 Whether the specified algorithm is a signature algorithm that can be used with psa_sign_hash() and psa_verify_hash(). More...
 
#define PSA_ALG_IS_SIGN_MESSAGE(alg)    (PSA_ALG_IS_SIGN_HASH(alg) || (alg) == PSA_ALG_PURE_EDDSA)
 Whether the specified algorithm is a signature algorithm that can be used with psa_sign_message() and psa_verify_message(). More...
 
#define PSA_ALG_IS_HASH_AND_SIGN(alg)
 Whether the specified algorithm is a hash-and-sign algorithm. More...
 
#define PSA_ALG_SIGN_GET_HASH(alg)
 Get the hash used by a hash-and-sign signature algorithm. More...
 
#define PSA_ALG_RSA_PKCS1V15_CRYPT   ((psa_algorithm_t) 0x07000200)
 RSA PKCS#1 v1.5 encryption. More...
 
#define PSA_ALG_RSA_OAEP_BASE   ((psa_algorithm_t) 0x07000300)
 
#define PSA_ALG_RSA_OAEP(hash_alg)    (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 RSA OAEP encryption. More...
 
#define PSA_ALG_IS_RSA_OAEP(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
 
#define PSA_ALG_RSA_OAEP_GET_HASH(alg)
 
#define PSA_ALG_HKDF_BASE   ((psa_algorithm_t) 0x08000100)
 
#define PSA_ALG_HKDF(hash_alg)    (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Macro to build an HKDF algorithm. More...
 
#define PSA_ALG_IS_HKDF(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
 Whether the specified algorithm is an HKDF algorithm. More...
 
#define PSA_ALG_HKDF_GET_HASH(hkdf_alg)    (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
 
#define PSA_ALG_TLS12_PRF_BASE   ((psa_algorithm_t) 0x08000200)
 
#define PSA_ALG_TLS12_PRF(hash_alg)    (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Macro to build a TLS-1.2 PRF algorithm. More...
 
#define PSA_ALG_IS_TLS12_PRF(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
 Whether the specified algorithm is a TLS-1.2 PRF algorithm. More...
 
#define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg)    (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
 
#define PSA_ALG_TLS12_PSK_TO_MS_BASE   ((psa_algorithm_t) 0x08000300)
 
#define PSA_ALG_TLS12_PSK_TO_MS(hash_alg)    (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
 Macro to build a TLS-1.2 PSK-to-MasterSecret algorithm. More...
 
#define PSA_ALG_IS_TLS12_PSK_TO_MS(alg)    (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
 Whether the specified algorithm is a TLS-1.2 PSK to MS algorithm. More...
 
#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg)    (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
 
#define PSA_ALG_KEY_DERIVATION_MASK   ((psa_algorithm_t) 0xfe00ffff)
 
#define PSA_ALG_KEY_AGREEMENT_MASK   ((psa_algorithm_t) 0xffff0000)
 
#define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg)    ((ka_alg) | (kdf_alg))
 Macro to build a combined algorithm that chains a key agreement with a key derivation. More...
 
#define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg)    (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
 
#define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg)    (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
 
#define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)
 Whether the specified algorithm is a raw key agreement algorithm. More...
 
#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg)    ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
 
#define PSA_ALG_FFDH   ((psa_algorithm_t) 0x09010000)
 The finite-field Diffie-Hellman (DH) key agreement algorithm. More...
 
#define PSA_ALG_IS_FFDH(alg)    (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
 Whether the specified algorithm is a finite field Diffie-Hellman algorithm. More...
 
#define PSA_ALG_ECDH   ((psa_algorithm_t) 0x09020000)
 The elliptic curve Diffie-Hellman (ECDH) key agreement algorithm. More...
 
#define PSA_ALG_IS_ECDH(alg)    (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
 Whether the specified algorithm is an elliptic curve Diffie-Hellman algorithm. More...
 
#define PSA_ALG_IS_WILDCARD(alg)
 Whether the specified algorithm encoding is a wildcard. More...
 

Typedefs

typedef uint16_t psa_key_type_t
 Encoding of a key type. More...
 
typedef uint8_t psa_ecc_family_t
 The type of PSA elliptic curve family identifiers. More...
 
typedef uint8_t psa_dh_family_t
 The type of PSA Diffie-Hellman group family identifiers. More...
 
typedef uint32_t psa_algorithm_t
 Encoding of a cryptographic algorithm. More...
 

Detailed Description

Macro Definition Documentation

◆ PSA_AEAD_TAG_LENGTH_OFFSET

#define PSA_AEAD_TAG_LENGTH_OFFSET   16

Definition at line 1214 of file crypto_values.h.

◆ PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG

#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG   ((psa_algorithm_t) 0x00008000)

Definition at line 1222 of file crypto_values.h.

◆ PSA_ALG_AEAD_FROM_BLOCK_FLAG

#define PSA_ALG_AEAD_FROM_BLOCK_FLAG   ((psa_algorithm_t) 0x00400000)

Definition at line 1171 of file crypto_values.h.

◆ PSA_ALG_AEAD_GET_TAG_LENGTH

#define PSA_ALG_AEAD_GET_TAG_LENGTH (   aead_alg)
Value:
(((aead_alg) & PSA_ALG_AEAD_TAG_LENGTH_MASK) >> \
PSA_AEAD_TAG_LENGTH_OFFSET)
#define PSA_ALG_AEAD_TAG_LENGTH_MASK

Retrieve the tag length of a specified AEAD algorithm.

Parameters
aead_algAn AEAD algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_AEAD(aead_alg) is true).
Returns
The tag length specified by the input algorithm.
Unspecified if aead_alg is not a supported AEAD algorithm.

Definition at line 1258 of file crypto_values.h.

◆ PSA_ALG_AEAD_TAG_LENGTH_MASK

#define PSA_ALG_AEAD_TAG_LENGTH_MASK   ((psa_algorithm_t) 0x003f0000)

Definition at line 1213 of file crypto_values.h.

◆ PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG

#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG (   aead_alg,
  min_tag_length 
)
Value:
(PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)
#define PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, tag_length)
Macro to build a shortened AEAD algorithm.

Macro to build an AEAD minimum-tag-length wildcard algorithm.

A minimum-tag-length AEAD wildcard algorithm permits all AEAD algorithms sharing the same base algorithm, and where the tag length of the specific algorithm is equal to or larger then the minimum tag length specified by the wildcard algorithm.

Note
When setting the minimum required tag length to less than the smallest tag length allowed by the base algorithm, this effectively becomes an 'any-tag-length-allowed' policy for that base algorithm.
Parameters
aead_algAn AEAD algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_AEAD(aead_alg) is true).
min_tag_lengthDesired minimum length of the authentication tag in bytes. This must be at least 1 and at most the largest allowed tag length of the algorithm.
Returns
The corresponding AEAD wildcard algorithm with the specified minimum length.
Unspecified if aead_alg is not a supported AEAD algorithm or if min_tag_length is less than 1 or too large for the specified AEAD algorithm.

Definition at line 1305 of file crypto_values.h.

◆ PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG

#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG (   aead_alg)
Value:
( \
PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CCM) \
PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_GCM) \
PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
0)
#define PSA_ALG_GCM
The GCM authenticated encryption algorithm.
#define PSA_ALG_CHACHA20_POLY1305
The Chacha20-Poly1305 AEAD algorithm.
#define PSA_ALG_CCM
The CCM authenticated encryption algorithm.

Calculate the corresponding AEAD algorithm with the default tag length.

Parameters
aead_algAn AEAD algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_AEAD(aead_alg) is true).
Returns
The corresponding AEAD algorithm with the default tag length for that algorithm.

Definition at line 1270 of file crypto_values.h.

◆ PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE

#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE (   aead_alg,
  ref 
)
Value:
PSA_ALG_AEAD_WITH_SHORTENED_TAG(ref, 0) ? \
ref :

Definition at line 1276 of file crypto_values.h.

◆ PSA_ALG_AEAD_WITH_SHORTENED_TAG

#define PSA_ALG_AEAD_WITH_SHORTENED_TAG (   aead_alg,
  tag_length 
)
Value:
(((aead_alg) & ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | \
((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
PSA_ALG_AEAD_TAG_LENGTH_MASK))
#define PSA_AEAD_TAG_LENGTH_OFFSET
#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG

Macro to build a shortened AEAD algorithm.

A shortened AEAD algorithm is similar to the corresponding AEAD algorithm, but has an authentication tag that consists of fewer bytes. Depending on the algorithm, the tag length may affect the calculation of the ciphertext.

Parameters
aead_algAn AEAD algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_AEAD(aead_alg) is true).
tag_lengthDesired length of the authentication tag in bytes.
Returns
The corresponding AEAD algorithm with the specified length.
Unspecified if aead_alg is not a supported AEAD algorithm or if tag_length is not valid for the specified AEAD algorithm.

Definition at line 1242 of file crypto_values.h.

◆ PSA_ALG_ANY_HASH

#define PSA_ALG_ANY_HASH   ((psa_algorithm_t) 0x020000ff)

In a hash-and-sign algorithm policy, allow any hash algorithm.

This value may be used to form the algorithm usage field of a policy for a signature algorithm that is parametrized by a hash. The key may then be used to perform operations using the same signature algorithm parametrized with any supported hash.

That is, suppose that `PSA_xxx_SIGNATURE` is one of the following macros:

This value may not be used to build other algorithms that are parametrized over a hash. For any valid use of this macro to build an algorithm alg, PSA_ALG_IS_HASH_AND_SIGN(alg) is true.

This value may not be used to build an algorithm specification to perform an operation. It is only valid to build policies.

Definition at line 907 of file crypto_values.h.

◆ PSA_ALG_AT_LEAST_THIS_LENGTH_MAC

#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC (   mac_alg,
  min_mac_length 
)
Value:
(PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)
#define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length)
Macro to build a truncated MAC algorithm.

Macro to build a MAC minimum-MAC-length wildcard algorithm.

A minimum-MAC-length MAC wildcard algorithm permits all MAC algorithms sharing the same base algorithm, and where the (potentially truncated) MAC length of the specific algorithm is equal to or larger then the wildcard algorithm's minimum MAC length.

Note
When setting the minimum required MAC length to less than the smallest MAC length allowed by the base algorithm, this effectively becomes an 'any-MAC-length-allowed' policy for that base algorithm.
Parameters
mac_algA MAC algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_MAC(mac_alg) is true).
min_mac_lengthDesired minimum length of the message authentication code in bytes. This must be at most the untruncated length of the MAC and must be at least 1.
Returns
The corresponding MAC wildcard algorithm with the specified minimum length.
Unspecified if mac_alg is not a supported MAC algorithm or if min_mac_length is less than 1 or too large for the specified MAC algorithm.

Definition at line 1052 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_AEAD

#define PSA_ALG_CATEGORY_AEAD   ((psa_algorithm_t) 0x05000000)

Definition at line 726 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION

#define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION   ((psa_algorithm_t) 0x07000000)

Definition at line 728 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_CIPHER

#define PSA_ALG_CATEGORY_CIPHER   ((psa_algorithm_t) 0x04000000)

Definition at line 725 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_HASH

#define PSA_ALG_CATEGORY_HASH   ((psa_algorithm_t) 0x02000000)

Definition at line 723 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_KEY_AGREEMENT

#define PSA_ALG_CATEGORY_KEY_AGREEMENT   ((psa_algorithm_t) 0x09000000)

Definition at line 730 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_KEY_DERIVATION

#define PSA_ALG_CATEGORY_KEY_DERIVATION   ((psa_algorithm_t) 0x08000000)

Definition at line 729 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_MAC

#define PSA_ALG_CATEGORY_MAC   ((psa_algorithm_t) 0x03000000)

Definition at line 724 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_MASK

#define PSA_ALG_CATEGORY_MASK   ((psa_algorithm_t) 0x7f000000)

Definition at line 722 of file crypto_values.h.

◆ PSA_ALG_CATEGORY_SIGN

#define PSA_ALG_CATEGORY_SIGN   ((psa_algorithm_t) 0x06000000)

Definition at line 727 of file crypto_values.h.

◆ PSA_ALG_CBC_MAC

#define PSA_ALG_CBC_MAC   ((psa_algorithm_t) 0x03c00100)

The CBC-MAC construction over a block cipher.

Warning
CBC-MAC is insecure in many cases. A more secure mode, such as PSA_ALG_CMAC, is recommended.

Definition at line 1062 of file crypto_values.h.

◆ PSA_ALG_CBC_NO_PADDING

#define PSA_ALG_CBC_NO_PADDING   ((psa_algorithm_t) 0x04404000)

The CBC block cipher chaining mode, with no padding.

The underlying block cipher is determined by the key type.

This symmetric cipher mode can only be used with messages whose lengths are whole number of blocks for the chosen block cipher.

Definition at line 1161 of file crypto_values.h.

◆ PSA_ALG_CBC_PKCS7

#define PSA_ALG_CBC_PKCS7   ((psa_algorithm_t) 0x04404100)

The CBC block cipher chaining mode with PKCS#7 padding.

The underlying block cipher is determined by the key type.

This is the padding method defined by PKCS#7 (RFC 2315) §10.3.

Definition at line 1169 of file crypto_values.h.

◆ PSA_ALG_CCM

#define PSA_ALG_CCM   ((psa_algorithm_t) 0x05500100)

The CCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.

Definition at line 1190 of file crypto_values.h.

◆ PSA_ALG_CFB

#define PSA_ALG_CFB   ((psa_algorithm_t) 0x04c01100)

The CFB stream cipher mode.

The underlying block cipher is determined by the key type.

Definition at line 1118 of file crypto_values.h.

◆ PSA_ALG_CHACHA20_POLY1305

#define PSA_ALG_CHACHA20_POLY1305   ((psa_algorithm_t) 0x05100500)

The Chacha20-Poly1305 AEAD algorithm.

The ChaCha20_Poly1305 construction is defined in RFC 7539.

Implementations must support 12-byte nonces, may support 8-byte nonces, and should reject other sizes.

Implementations must support 16-byte tags and should reject other sizes.

Definition at line 1207 of file crypto_values.h.

◆ PSA_ALG_CIPHER_FROM_BLOCK_FLAG

#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG   ((psa_algorithm_t) 0x00400000)

Definition at line 1079 of file crypto_values.h.

◆ PSA_ALG_CIPHER_MAC_BASE

#define PSA_ALG_CIPHER_MAC_BASE   ((psa_algorithm_t) 0x03c00000)

Definition at line 1056 of file crypto_values.h.

◆ PSA_ALG_CIPHER_STREAM_FLAG

#define PSA_ALG_CIPHER_STREAM_FLAG   ((psa_algorithm_t) 0x00800000)

Definition at line 1078 of file crypto_values.h.

◆ PSA_ALG_CMAC

#define PSA_ALG_CMAC   ((psa_algorithm_t) 0x03c00200)

The CMAC construction over a block cipher.

Definition at line 1064 of file crypto_values.h.

◆ PSA_ALG_CTR

#define PSA_ALG_CTR   ((psa_algorithm_t) 0x04c01000)

The CTR stream cipher mode.

CTR is a stream cipher which is built from a block cipher. The underlying block cipher is determined by the key type. For example, to use AES-128-CTR, use this algorithm with a key of type PSA_KEY_TYPE_AES and a length of 128 bits (16 bytes).

Definition at line 1112 of file crypto_values.h.

◆ PSA_ALG_DETERMINISTIC_DSA

#define PSA_ALG_DETERMINISTIC_DSA (   hash_alg)     (PSA_ALG_DETERMINISTIC_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Deterministic DSA signature with hashing.

This is the deterministic variant defined by RFC 6979 of the signature scheme defined by FIPS 186-4.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding DSA signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 395 of file crypto_extra.h.

◆ PSA_ALG_DETERMINISTIC_DSA_BASE

#define PSA_ALG_DETERMINISTIC_DSA_BASE   ((psa_algorithm_t) 0x06000500)

Definition at line 379 of file crypto_extra.h.

◆ PSA_ALG_DETERMINISTIC_ECDSA

#define PSA_ALG_DETERMINISTIC_ECDSA (   hash_alg)     (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Deterministic ECDSA signature with hashing.

This is the deterministic ECDSA signature scheme defined by RFC 6979.

The representation of a signature is the same as with PSA_ALG_ECDSA().

Note that when this algorithm is used for verification, signatures made with randomized ECDSA (PSA_ALG_ECDSA(hash_alg)) with the same private key are accepted. In other words, PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) differs from PSA_ALG_ECDSA(hash_alg) only for signature, not for verification.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding deterministic ECDSA signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1483 of file crypto_values.h.

◆ PSA_ALG_DETERMINISTIC_ECDSA_BASE

#define PSA_ALG_DETERMINISTIC_ECDSA_BASE   ((psa_algorithm_t) 0x06000700)

Definition at line 1460 of file crypto_values.h.

◆ PSA_ALG_DSA

#define PSA_ALG_DSA (   hash_alg)     (PSA_ALG_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

DSA signature with hashing.

This is the signature scheme defined by FIPS 186-4, with a random per-message secret number (*k*).

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding DSA signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 377 of file crypto_extra.h.

◆ PSA_ALG_DSA_BASE

#define PSA_ALG_DSA_BASE   ((psa_algorithm_t) 0x06000400)

Definition at line 362 of file crypto_extra.h.

◆ PSA_ALG_DSA_DETERMINISTIC_FLAG

#define PSA_ALG_DSA_DETERMINISTIC_FLAG   PSA_ALG_ECDSA_DETERMINISTIC_FLAG

Definition at line 380 of file crypto_extra.h.

◆ PSA_ALG_DSA_IS_DETERMINISTIC

#define PSA_ALG_DSA_IS_DETERMINISTIC (   alg)     (((alg) & PSA_ALG_DSA_DETERMINISTIC_FLAG) != 0)

Definition at line 400 of file crypto_extra.h.

◆ PSA_ALG_ECB_NO_PADDING

#define PSA_ALG_ECB_NO_PADDING   ((psa_algorithm_t) 0x04404400)

The Electronic Code Book (ECB) mode of a block cipher, with no padding.

Warning
ECB mode does not protect the confidentiality of the encrypted data except in extremely narrow circumstances. It is recommended that applications only use ECB if they need to construct an operating mode that the implementation does not provide. Implementations are encouraged to provide the modes that applications need in preference to supporting direct access to ECB.

The underlying block cipher is determined by the key type.

This symmetric cipher mode can only be used with messages whose lengths are a multiple of the block size of the chosen block cipher.

ECB mode does not accept an initialization vector (IV). When using a multi-part cipher operation with this algorithm, psa_cipher_generate_iv() and psa_cipher_set_iv() must not be called.

Definition at line 1152 of file crypto_values.h.

◆ PSA_ALG_ECDH

#define PSA_ALG_ECDH   ((psa_algorithm_t) 0x09020000)

The elliptic curve Diffie-Hellman (ECDH) key agreement algorithm.

The shared secret produced by key agreement is the x-coordinate of the shared secret point. It is always `ceiling(m / 8)` bytes long where `m` is the bit size associated with the curve, i.e. the bit size of the order of the curve's coordinate field. When `m` is not a multiple of 8, the byte containing the most significant bit of the shared secret is padded with zero bits. The byte order is either little-endian or big-endian depending on the curve type.

  • For Montgomery curves (curve types `PSA_ECC_FAMILY_CURVEXXX`), the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A` in little-endian byte order. The bit size is 448 for Curve448 and 255 for Curve25519.
  • For Weierstrass curves over prime fields (curve types `PSA_ECC_FAMILY_SECPXXX` and `PSA_ECC_FAMILY_BRAINPOOL_PXXX`), the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A` in big-endian byte order. The bit size is `m = ceiling(log_2(p))` for the field `F_p`.
  • For Weierstrass curves over binary fields (curve types `PSA_ECC_FAMILY_SECTXXX`), the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A` in big-endian byte order. The bit size is `m` for the field `F_{2^m}`.

Definition at line 1925 of file crypto_values.h.

◆ PSA_ALG_ECDSA

#define PSA_ALG_ECDSA (   hash_alg)     (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

ECDSA signature with hashing.

This is the ECDSA signature scheme defined by ANSI X9.62, with a random per-message secret number (*k*).

The representation of the signature as a byte string consists of the concatenation of the signature values *r* and *s*. Each of *r* and *s* is encoded as an *N*-octet string, where *N* is the length of the base point of the curve in octets. Each value is represented in big-endian order (most significant octet first).

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding ECDSA signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1448 of file crypto_values.h.

◆ PSA_ALG_ECDSA_ANY

#define PSA_ALG_ECDSA_ANY   PSA_ALG_ECDSA_BASE

ECDSA signature without hashing.

This is the same signature scheme as PSA_ALG_ECDSA(), but without specifying a hash algorithm. This algorithm may only be used to sign or verify a sequence of bytes that should be an already-calculated hash. Note that the input is padded with zeros on the left or truncated on the left as required to fit the curve size.

Definition at line 1459 of file crypto_values.h.

◆ PSA_ALG_ECDSA_BASE

#define PSA_ALG_ECDSA_BASE   ((psa_algorithm_t) 0x06000600)

Definition at line 1427 of file crypto_values.h.

◆ PSA_ALG_ECDSA_DETERMINISTIC_FLAG

#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG   ((psa_algorithm_t) 0x00000100)

Definition at line 1485 of file crypto_values.h.

◆ PSA_ALG_ECDSA_IS_DETERMINISTIC

#define PSA_ALG_ECDSA_IS_DETERMINISTIC (   alg)     (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)

Definition at line 1489 of file crypto_values.h.

◆ PSA_ALG_ED25519PH

#define PSA_ALG_ED25519PH    (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHA_512 & PSA_ALG_HASH_MASK))

Edwards-curve digital signature algorithm with prehashing (HashEdDSA), using SHA-512 and the Edwards25519 curve.

See PSA_ALG_PURE_EDDSA regarding context support and the signature format.

This algorithm is Ed25519 as specified in RFC 8032. The curve is Edwards25519. The prehash is SHA-512. The hash function used internally is SHA-512.

This is a hash-and-sign algorithm: to calculate a signature, you can either:

Definition at line 1551 of file crypto_values.h.

◆ PSA_ALG_ED448PH

#define PSA_ALG_ED448PH    (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHAKE256_512 & PSA_ALG_HASH_MASK))

Edwards-curve digital signature algorithm with prehashing (HashEdDSA), using SHAKE256 and the Edwards448 curve.

See PSA_ALG_PURE_EDDSA regarding context support and the signature format.

This algorithm is Ed448 as specified in RFC 8032. The curve is Edwards448. The prehash is the first 64 bytes of the SHAKE256 output. The hash function used internally is the first 114 bytes of the SHAKE256 output.

This is a hash-and-sign algorithm: to calculate a signature, you can either:

Definition at line 1576 of file crypto_values.h.

◆ PSA_ALG_FFDH

#define PSA_ALG_FFDH   ((psa_algorithm_t) 0x09010000)

The finite-field Diffie-Hellman (DH) key agreement algorithm.

The shared secret produced by key agreement is `g^{ab}` in big-endian format. It is `ceiling(m / 8)` bytes long where `m` is the size of the prime `p` in bits.

Definition at line 1883 of file crypto_values.h.

◆ PSA_ALG_FULL_LENGTH_MAC

#define PSA_ALG_FULL_LENGTH_MAC (   mac_alg)
Value:
((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
#define PSA_ALG_MAC_TRUNCATION_MASK
#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG

Macro to build the base MAC algorithm corresponding to a truncated MAC algorithm.

Parameters
mac_algA MAC algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_MAC(mac_alg) is true). This may be a truncated or untruncated MAC algorithm.
Returns
The corresponding base MAC algorithm.
Unspecified if mac_alg is not a supported MAC algorithm.

Definition at line 1010 of file crypto_values.h.

◆ PSA_ALG_GCM

#define PSA_ALG_GCM   ((psa_algorithm_t) 0x05500200)

The GCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.

Definition at line 1196 of file crypto_values.h.

◆ PSA_ALG_HASH_EDDSA_BASE

#define PSA_ALG_HASH_EDDSA_BASE   ((psa_algorithm_t) 0x06000900)

Definition at line 1526 of file crypto_values.h.

◆ PSA_ALG_HASH_MASK

#define PSA_ALG_HASH_MASK   ((psa_algorithm_t) 0x000000ff)

Definition at line 835 of file crypto_values.h.

◆ PSA_ALG_HKDF

#define PSA_ALG_HKDF (   hash_alg)     (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Macro to build an HKDF algorithm.

For example, `PSA_ALG_HKDF(PSA_ALG_SHA_256)` is HKDF using HMAC-SHA-256.

This key derivation algorithm uses the following inputs:

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true).
Returns
The corresponding HKDF algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1722 of file crypto_values.h.

◆ PSA_ALG_HKDF_BASE

#define PSA_ALG_HKDF_BASE   ((psa_algorithm_t) 0x08000100)

Definition at line 1701 of file crypto_values.h.

◆ PSA_ALG_HKDF_GET_HASH

#define PSA_ALG_HKDF_GET_HASH (   hkdf_alg)     (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))

Definition at line 1737 of file crypto_values.h.

◆ PSA_ALG_HMAC

#define PSA_ALG_HMAC (   hash_alg)     (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Macro to build an HMAC algorithm.

For example, PSA_ALG_HMAC(PSA_ALG_SHA_256) is HMAC-SHA-256.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true).
Returns
The corresponding HMAC algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 922 of file crypto_values.h.

◆ PSA_ALG_HMAC_BASE

#define PSA_ALG_HMAC_BASE   ((psa_algorithm_t) 0x03800000)

Definition at line 910 of file crypto_values.h.

◆ PSA_ALG_HMAC_GET_HASH

#define PSA_ALG_HMAC_GET_HASH (   hmac_alg)     (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))

Definition at line 925 of file crypto_values.h.

◆ PSA_ALG_IS_AEAD

#define PSA_ALG_IS_AEAD (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)

Whether the specified algorithm is an authenticated encryption with associated data (AEAD) algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an AEAD algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 781 of file crypto_values.h.

◆ PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER

#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER (   alg)
Value:
#define PSA_ALG_AEAD_FROM_BLOCK_FLAG
#define PSA_ALG_CATEGORY_MASK
#define PSA_ALG_CATEGORY_AEAD

Whether the specified algorithm is an AEAD mode on a block cipher.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an AEAD algorithm which is an AEAD mode based on a block cipher, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1182 of file crypto_values.h.

◆ PSA_ALG_IS_ASYMMETRIC_ENCRYPTION

#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)

Whether the specified algorithm is an asymmetric encryption algorithm, also known as public-key encryption algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an asymmetric encryption algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 805 of file crypto_values.h.

◆ PSA_ALG_IS_BLOCK_CIPHER_MAC

#define PSA_ALG_IS_BLOCK_CIPHER_MAC (   alg)
Value:
#define PSA_ALG_MAC_SUBCATEGORY_MASK
#define PSA_ALG_CIPHER_MAC_BASE

Whether the specified algorithm is a MAC algorithm based on a block cipher.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a MAC algorithm based on a block cipher, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1074 of file crypto_values.h.

◆ PSA_ALG_IS_CIPHER

#define PSA_ALG_IS_CIPHER (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)

Whether the specified algorithm is a symmetric cipher algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a symmetric cipher algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 769 of file crypto_values.h.

◆ PSA_ALG_IS_DETERMINISTIC_DSA

#define PSA_ALG_IS_DETERMINISTIC_DSA (   alg)     (PSA_ALG_IS_DSA(alg) && PSA_ALG_DSA_IS_DETERMINISTIC(alg))

Definition at line 402 of file crypto_extra.h.

◆ PSA_ALG_IS_DETERMINISTIC_ECDSA

#define PSA_ALG_IS_DETERMINISTIC_ECDSA (   alg)     (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))

Definition at line 1491 of file crypto_values.h.

◆ PSA_ALG_IS_DSA

#define PSA_ALG_IS_DSA (   alg)
Value:
PSA_ALG_DSA_BASE)
#define PSA_ALG_DSA_DETERMINISTIC_FLAG
Definition: crypto_extra.h:380
#define PSA_ALG_HASH_MASK

Definition at line 397 of file crypto_extra.h.

◆ PSA_ALG_IS_ECDH

#define PSA_ALG_IS_ECDH (   alg)     (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)

Whether the specified algorithm is an elliptic curve Diffie-Hellman algorithm.

This includes the raw elliptic curve Diffie-Hellman algorithm as well as elliptic curve Diffie-Hellman followed by any supporter key derivation algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an elliptic curve Diffie-Hellman algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key agreement algorithm identifier.

Definition at line 1941 of file crypto_values.h.

◆ PSA_ALG_IS_ECDSA

#define PSA_ALG_IS_ECDSA (   alg)
Value:
PSA_ALG_ECDSA_BASE)
#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG

Definition at line 1486 of file crypto_values.h.

◆ PSA_ALG_IS_FFDH

#define PSA_ALG_IS_FFDH (   alg)     (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)

Whether the specified algorithm is a finite field Diffie-Hellman algorithm.

This includes the raw finite field Diffie-Hellman algorithm as well as finite-field Diffie-Hellman followed by any supporter key derivation algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a finite field Diffie-Hellman algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key agreement algorithm identifier.

Definition at line 1897 of file crypto_values.h.

◆ PSA_ALG_IS_HASH

#define PSA_ALG_IS_HASH (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)

Whether the specified algorithm is a hash algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a hash algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 747 of file crypto_values.h.

◆ PSA_ALG_IS_HASH_AND_SIGN

#define PSA_ALG_IS_HASH_AND_SIGN (   alg)
Value:
((alg) & PSA_ALG_HASH_MASK) != 0)
#define PSA_ALG_IS_SIGN_HASH(alg)
Whether the specified algorithm is a signature algorithm that can be used with psa_sign_hash() and ps...

Whether the specified algorithm is a hash-and-sign algorithm.

Hash-and-sign algorithms are asymmetric (public-key) signature algorithms structured in two parts: first the calculation of a hash in a way that does not depend on the key, then the calculation of a signature from the hash value and the key. Hash-and-sign algorithms encode the hash used for the hashing step, and you can call PSA_ALG_SIGN_GET_HASH to extract this algorithm.

Thus, for a hash-and-sign algorithm, `psa_sign_message(key, alg, input, ...)` is equivalent to ``` psa_hash_compute(PSA_ALG_SIGN_GET_HASH(alg), input, ..., hash, ...); psa_sign_hash(key, alg, hash, ..., signature, ...); ``` Most usefully, separating the hash from the signature allows the hash to be calculated in multiple steps with psa_hash_setup(), psa_hash_update() and psa_hash_finish(). Likewise psa_verify_message() is equivalent to calculating the hash and then calling psa_verify_hash().

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a hash-and-sign algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1646 of file crypto_values.h.

◆ PSA_ALG_IS_HASH_EDDSA

#define PSA_ALG_IS_HASH_EDDSA (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HASH_EDDSA_BASE)

Definition at line 1527 of file crypto_values.h.

◆ PSA_ALG_IS_HKDF

#define PSA_ALG_IS_HKDF (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)

Whether the specified algorithm is an HKDF algorithm.

HKDF is a family of key derivation algorithms that are based on a hash function and the HMAC construction.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an HKDF algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.

Definition at line 1735 of file crypto_values.h.

◆ PSA_ALG_IS_HMAC

#define PSA_ALG_IS_HMAC (   alg)
Value:

Whether the specified algorithm is an HMAC algorithm.

HMAC is a family of MAC algorithms that are based on a hash function.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an HMAC algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 938 of file crypto_values.h.

◆ PSA_ALG_IS_KEY_AGREEMENT

#define PSA_ALG_IS_KEY_AGREEMENT (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)

Whether the specified algorithm is a key agreement algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a key agreement algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 816 of file crypto_values.h.

◆ PSA_ALG_IS_KEY_DERIVATION

#define PSA_ALG_IS_KEY_DERIVATION (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)

Whether the specified algorithm is a key derivation algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a key derivation algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 827 of file crypto_values.h.

◆ PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT

#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT (   alg)     ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))

Definition at line 1873 of file crypto_values.h.

◆ PSA_ALG_IS_MAC

#define PSA_ALG_IS_MAC (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)

Whether the specified algorithm is a MAC algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a MAC algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 758 of file crypto_values.h.

◆ PSA_ALG_IS_RANDOMIZED_DSA

#define PSA_ALG_IS_RANDOMIZED_DSA (   alg)     (PSA_ALG_IS_DSA(alg) && !PSA_ALG_DSA_IS_DETERMINISTIC(alg))

Definition at line 404 of file crypto_extra.h.

◆ PSA_ALG_IS_RANDOMIZED_ECDSA

#define PSA_ALG_IS_RANDOMIZED_ECDSA (   alg)     (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))

Definition at line 1493 of file crypto_values.h.

◆ PSA_ALG_IS_RAW_KEY_AGREEMENT

#define PSA_ALG_IS_RAW_KEY_AGREEMENT (   alg)
Value:
PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
#define PSA_ALG_IS_KEY_AGREEMENT(alg)
Whether the specified algorithm is a key agreement algorithm.
#define PSA_ALG_CATEGORY_KEY_DERIVATION

Whether the specified algorithm is a raw key agreement algorithm.

A raw key agreement algorithm is one that does not specify a key derivation function. Usually, raw key agreement algorithms are constructed directly with a PSA_ALG_xxx macro while non-raw key agreement algorithms are constructed with PSA_ALG_KEY_AGREEMENT().

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a raw key agreement algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1869 of file crypto_values.h.

◆ PSA_ALG_IS_RSA_OAEP

#define PSA_ALG_IS_RSA_OAEP (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)

Definition at line 1694 of file crypto_values.h.

◆ PSA_ALG_IS_RSA_PKCS1V15_SIGN

#define PSA_ALG_IS_RSA_PKCS1V15_SIGN (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)

Definition at line 1334 of file crypto_values.h.

◆ PSA_ALG_IS_RSA_PSS

#define PSA_ALG_IS_RSA_PSS (   alg)
Value:
PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))
#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg)
Whether the specified algorithm is RSA PSS with standard salt.

Whether the specified algorithm is RSA PSS.

This includes any of the RSA PSS algorithm variants, regardless of the constraints on salt length.

Parameters
algAn algorithm value or an algorithm policy wildcard.
Returns
1 if alg is of the form PSA_ALG_RSA_PSS(hash_alg) or PSA_ALG_RSA_PSS_ANY_SALT_BASE(hash_alg), where hash_alg is a hash algorithm or PSA_ALG_ANY_HASH. 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier or policy.

Definition at line 1423 of file crypto_values.h.

◆ PSA_ALG_IS_RSA_PSS_ANY_SALT

#define PSA_ALG_IS_RSA_PSS_ANY_SALT (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_ANY_SALT_BASE)

Whether the specified algorithm is RSA PSS with any salt.

Parameters
algAn algorithm value or an algorithm policy wildcard.
Returns
1 if alg is of the form PSA_ALG_RSA_PSS_ANY_SALT_BASE(hash_alg), where hash_alg is a hash algorithm or PSA_ALG_ANY_HASH. 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier or policy.

Definition at line 1405 of file crypto_values.h.

◆ PSA_ALG_IS_RSA_PSS_STANDARD_SALT

#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)

Whether the specified algorithm is RSA PSS with standard salt.

Parameters
algAn algorithm value or an algorithm policy wildcard.
Returns
1 if alg is of the form PSA_ALG_RSA_PSS(hash_alg), where hash_alg is a hash algorithm or PSA_ALG_ANY_HASH. 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier or policy.

Definition at line 1391 of file crypto_values.h.

◆ PSA_ALG_IS_SIGN

#define PSA_ALG_IS_SIGN (   alg)     (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)

Whether the specified algorithm is an asymmetric signature algorithm, also known as public-key signature algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is an asymmetric signature algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 793 of file crypto_values.h.

◆ PSA_ALG_IS_SIGN_HASH

#define PSA_ALG_IS_SIGN_HASH (   alg)
Value:
PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))
#define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg)
#define PSA_ALG_IS_HASH_EDDSA(alg)
#define PSA_ALG_IS_RSA_PSS(alg)
Whether the specified algorithm is RSA PSS.

Whether the specified algorithm is a signature algorithm that can be used with psa_sign_hash() and psa_verify_hash().

This encompasses all strict hash-and-sign algorithms categorized by PSA_ALG_IS_HASH_AND_SIGN(), as well as algorithms that follow the paradigm more loosely:

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a signature algorithm that can be used to sign a hash. 0 if alg is a signature algorithm that can only be used to sign a message. 0 if alg is not a signature algorithm. This macro can return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1601 of file crypto_values.h.

◆ PSA_ALG_IS_SIGN_MESSAGE

#define PSA_ALG_IS_SIGN_MESSAGE (   alg)     (PSA_ALG_IS_SIGN_HASH(alg) || (alg) == PSA_ALG_PURE_EDDSA)

Whether the specified algorithm is a signature algorithm that can be used with psa_sign_message() and psa_verify_message().

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a signature algorithm that can be used to sign a message. 0 if alg is a signature algorithm that can only be used to sign an already-calculated hash. 0 if alg is not a signature algorithm. This macro can return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1617 of file crypto_values.h.

◆ PSA_ALG_IS_STREAM_CIPHER

#define PSA_ALG_IS_STREAM_CIPHER (   alg)
Value:

Whether the specified algorithm is a stream cipher.

A stream cipher is a symmetric cipher that encrypts or decrypts messages by applying a bitwise-xor with a stream of bytes that is generated from a key.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a stream cipher algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier or if it is not a symmetric cipher algorithm.

Definition at line 1093 of file crypto_values.h.

◆ PSA_ALG_IS_TLS12_PRF

#define PSA_ALG_IS_TLS12_PRF (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)

Whether the specified algorithm is a TLS-1.2 PRF algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a TLS-1.2 PRF algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.

Definition at line 1778 of file crypto_values.h.

◆ PSA_ALG_IS_TLS12_PSK_TO_MS

#define PSA_ALG_IS_TLS12_PSK_TO_MS (   alg)     (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)

Whether the specified algorithm is a TLS-1.2 PSK to MS algorithm.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a TLS-1.2 PSK to MS algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.

Definition at line 1824 of file crypto_values.h.

◆ PSA_ALG_IS_VENDOR_DEFINED

#define PSA_ALG_IS_VENDOR_DEFINED (   alg)     (((alg) & PSA_ALG_VENDOR_FLAG) != 0)

Whether an algorithm is vendor-defined.

See also PSA_ALG_VENDOR_FLAG.

Definition at line 736 of file crypto_values.h.

◆ PSA_ALG_IS_VENDOR_HASH_AND_SIGN [1/2]

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN (   alg)     PSA_ALG_IS_DSA(alg)

Definition at line 411 of file crypto_extra.h.

◆ PSA_ALG_IS_VENDOR_HASH_AND_SIGN [2/2]

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN (   alg)    0

Definition at line 1582 of file crypto_values.h.

◆ PSA_ALG_IS_WILDCARD

#define PSA_ALG_IS_WILDCARD (   alg)
Value:
PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
PSA_ALG_IS_MAC(alg) ? \
PSA_ALG_IS_AEAD(alg) ? \
(alg) == PSA_ALG_ANY_HASH)
#define PSA_ALG_IS_AEAD(alg)
Whether the specified algorithm is an authenticated encryption with associated data (AEAD) algorithm.
#define PSA_ALG_ANY_HASH
In a hash-and-sign algorithm policy, allow any hash algorithm.
#define PSA_ALG_IS_HASH_AND_SIGN(alg)
Whether the specified algorithm is a hash-and-sign algorithm.

Whether the specified algorithm encoding is a wildcard.

Wildcard values may only be used to set the usage algorithm field in a policy, not to perform an operation.

Parameters
algAn algorithm identifier (value of type psa_algorithm_t).
Returns
1 if alg is a wildcard algorithm encoding.
0 if alg is a non-wildcard algorithm encoding (suitable for an operation).
This macro may return either 0 or 1 if alg is not a supported algorithm identifier.

Definition at line 1957 of file crypto_values.h.

◆ PSA_ALG_KEY_AGREEMENT

#define PSA_ALG_KEY_AGREEMENT (   ka_alg,
  kdf_alg 
)     ((ka_alg) | (kdf_alg))

Macro to build a combined algorithm that chains a key agreement with a key derivation.

Parameters
ka_algA key agreement algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_KEY_AGREEMENT(ka_alg) is true).
kdf_algA key derivation algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_KEY_DERIVATION(kdf_alg) is true).
Returns
The corresponding key agreement and derivation algorithm.
Unspecified if ka_alg is not a supported key agreement algorithm or kdf_alg is not a supported key derivation algorithm.

Definition at line 1846 of file crypto_values.h.

◆ PSA_ALG_KEY_AGREEMENT_GET_BASE

#define PSA_ALG_KEY_AGREEMENT_GET_BASE (   alg)     (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)

Definition at line 1852 of file crypto_values.h.

◆ PSA_ALG_KEY_AGREEMENT_GET_KDF

#define PSA_ALG_KEY_AGREEMENT_GET_KDF (   alg)     (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)

Definition at line 1849 of file crypto_values.h.

◆ PSA_ALG_KEY_AGREEMENT_MASK

#define PSA_ALG_KEY_AGREEMENT_MASK   ((psa_algorithm_t) 0xffff0000)

Definition at line 1830 of file crypto_values.h.

◆ PSA_ALG_KEY_DERIVATION_MASK

#define PSA_ALG_KEY_DERIVATION_MASK   ((psa_algorithm_t) 0xfe00ffff)

Definition at line 1829 of file crypto_values.h.

◆ PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG

#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG   ((psa_algorithm_t) 0x00008000)

Definition at line 958 of file crypto_values.h.

◆ PSA_ALG_MAC_SUBCATEGORY_MASK

#define PSA_ALG_MAC_SUBCATEGORY_MASK   ((psa_algorithm_t) 0x00c00000)

Definition at line 909 of file crypto_values.h.

◆ PSA_ALG_MAC_TRUNCATION_MASK

#define PSA_ALG_MAC_TRUNCATION_MASK   ((psa_algorithm_t) 0x003f0000)

Definition at line 949 of file crypto_values.h.

◆ PSA_ALG_MD2

#define PSA_ALG_MD2   ((psa_algorithm_t) 0x02000001)

MD2.

Definition at line 837 of file crypto_values.h.

◆ PSA_ALG_MD4

#define PSA_ALG_MD4   ((psa_algorithm_t) 0x02000002)

MD4.

Definition at line 839 of file crypto_values.h.

◆ PSA_ALG_MD5

#define PSA_ALG_MD5   ((psa_algorithm_t) 0x02000003)

MD5.

Definition at line 841 of file crypto_values.h.

◆ PSA_ALG_NONE

#define PSA_ALG_NONE   ((psa_algorithm_t)0)

An invalid algorithm identifier value.

Definition at line 832 of file crypto_values.h.

◆ PSA_ALG_OFB

#define PSA_ALG_OFB   ((psa_algorithm_t) 0x04c01200)

The OFB stream cipher mode.

The underlying block cipher is determined by the key type.

Definition at line 1124 of file crypto_values.h.

◆ PSA_ALG_PURE_EDDSA

#define PSA_ALG_PURE_EDDSA   ((psa_algorithm_t) 0x06000800)

Edwards-curve digital signature algorithm without prehashing (PureEdDSA), using standard parameters.

Contexts are not supported in the current version of this specification because there is no suitable signature interface that can take the context as a parameter. A future version of this specification may add suitable functions and extend this algorithm to support contexts.

PureEdDSA requires an elliptic curve key on a twisted Edwards curve. In this specification, the following curves are supported:

  • PSA_ECC_FAMILY_TWISTED_EDWARDS, 255-bit: Ed25519 as specified in RFC 8032. The curve is Edwards25519. The hash function used internally is SHA-512.
  • PSA_ECC_FAMILY_TWISTED_EDWARDS, 448-bit: Ed448 as specified in RFC 8032. The curve is Edwards448. The hash function used internally is the first 114 bytes of the SHAKE256 output.

This algorithm can be used with psa_sign_message() and psa_verify_message(). Since there is no prehashing, it cannot be used with psa_sign_hash() or psa_verify_hash().

The signature format is the concatenation of R and S as defined by RFC 8032 §5.1.6 and §5.2.6 (a 64-byte string for Ed25519, a 114-byte string for Ed448).

Definition at line 1524 of file crypto_values.h.

◆ PSA_ALG_RIPEMD160

#define PSA_ALG_RIPEMD160   ((psa_algorithm_t) 0x02000004)

PSA_ALG_RIPEMD160.

Definition at line 843 of file crypto_values.h.

◆ PSA_ALG_RSA_OAEP

#define PSA_ALG_RSA_OAEP (   hash_alg)     (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

RSA OAEP encryption.

This is the encryption scheme defined by RFC 8017 (PKCS#1: RSA Cryptography Specifications) under the name RSAES-OAEP, with the message generation function MGF1.

Parameters
hash_algThe hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true) to use for MGF1.
Returns
The corresponding RSA OAEP encryption algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1692 of file crypto_values.h.

◆ PSA_ALG_RSA_OAEP_BASE

#define PSA_ALG_RSA_OAEP_BASE   ((psa_algorithm_t) 0x07000300)

Definition at line 1677 of file crypto_values.h.

◆ PSA_ALG_RSA_OAEP_GET_HASH

#define PSA_ALG_RSA_OAEP_GET_HASH (   alg)
Value:
0)
#define PSA_ALG_IS_RSA_OAEP(alg)
#define PSA_ALG_CATEGORY_HASH

Definition at line 1696 of file crypto_values.h.

◆ PSA_ALG_RSA_PKCS1V15_CRYPT

#define PSA_ALG_RSA_PKCS1V15_CRYPT   ((psa_algorithm_t) 0x07000200)

RSA PKCS#1 v1.5 encryption.

Definition at line 1675 of file crypto_values.h.

◆ PSA_ALG_RSA_PKCS1V15_SIGN

#define PSA_ALG_RSA_PKCS1V15_SIGN (   hash_alg)     (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

RSA PKCS#1 v1.5 signature with hashing.

This is the signature scheme defined by RFC 8017 (PKCS#1: RSA Cryptography Specifications) under the name RSASSA-PKCS1-v1_5.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding RSA PKCS#1 v1.5 signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1325 of file crypto_values.h.

◆ PSA_ALG_RSA_PKCS1V15_SIGN_BASE

#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE   ((psa_algorithm_t) 0x06000200)

Definition at line 1309 of file crypto_values.h.

◆ PSA_ALG_RSA_PKCS1V15_SIGN_RAW

#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW   PSA_ALG_RSA_PKCS1V15_SIGN_BASE

Raw PKCS#1 v1.5 signature.

The input to this algorithm is the DigestInfo structure used by RFC 8017 (PKCS#1: RSA Cryptography Specifications), §9.2 steps 3–6.

Definition at line 1333 of file crypto_values.h.

◆ PSA_ALG_RSA_PSS

#define PSA_ALG_RSA_PSS (   hash_alg)     (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

RSA PSS signature with hashing.

This is the signature scheme defined by RFC 8017 (PKCS#1: RSA Cryptography Specifications) under the name RSASSA-PSS, with the message generation function MGF1, and with a salt length equal to the length of the hash, or the largest possible salt length for the algorithm and key size if that is smaller than the hash length. The specified hash algorithm is used to hash the input message, to create the salted hash, and for the mask generation.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding RSA PSS signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1359 of file crypto_values.h.

◆ PSA_ALG_RSA_PSS_ANY_SALT

#define PSA_ALG_RSA_PSS_ANY_SALT (   hash_alg)     (PSA_ALG_RSA_PSS_ANY_SALT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

RSA PSS signature with hashing with relaxed verification.

This algorithm has the same behavior as PSA_ALG_RSA_PSS when signing, but allows an arbitrary salt length (including 0) when verifying a signature.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true). This includes PSA_ALG_ANY_HASH when specifying the algorithm in a usage policy.
Returns
The corresponding RSA PSS signature algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1377 of file crypto_values.h.

◆ PSA_ALG_RSA_PSS_ANY_SALT_BASE

#define PSA_ALG_RSA_PSS_ANY_SALT_BASE   ((psa_algorithm_t) 0x06001300)

Definition at line 1338 of file crypto_values.h.

◆ PSA_ALG_RSA_PSS_BASE

#define PSA_ALG_RSA_PSS_BASE   ((psa_algorithm_t) 0x06000300)

Definition at line 1337 of file crypto_values.h.

◆ PSA_ALG_SHA3_224

#define PSA_ALG_SHA3_224   ((psa_algorithm_t) 0x02000010)

SHA3-224.

Definition at line 859 of file crypto_values.h.

◆ PSA_ALG_SHA3_256

#define PSA_ALG_SHA3_256   ((psa_algorithm_t) 0x02000011)

SHA3-256.

Definition at line 861 of file crypto_values.h.

◆ PSA_ALG_SHA3_384

#define PSA_ALG_SHA3_384   ((psa_algorithm_t) 0x02000012)

SHA3-384.

Definition at line 863 of file crypto_values.h.

◆ PSA_ALG_SHA3_512

#define PSA_ALG_SHA3_512   ((psa_algorithm_t) 0x02000013)

SHA3-512.

Definition at line 865 of file crypto_values.h.

◆ PSA_ALG_SHA_1

#define PSA_ALG_SHA_1   ((psa_algorithm_t) 0x02000005)

SHA1.

Definition at line 845 of file crypto_values.h.

◆ PSA_ALG_SHA_224

#define PSA_ALG_SHA_224   ((psa_algorithm_t) 0x02000008)

SHA2-224.

Definition at line 847 of file crypto_values.h.

◆ PSA_ALG_SHA_256

#define PSA_ALG_SHA_256   ((psa_algorithm_t) 0x02000009)

SHA2-256.

Definition at line 849 of file crypto_values.h.

◆ PSA_ALG_SHA_384

#define PSA_ALG_SHA_384   ((psa_algorithm_t) 0x0200000a)

SHA2-384.

Definition at line 851 of file crypto_values.h.

◆ PSA_ALG_SHA_512

#define PSA_ALG_SHA_512   ((psa_algorithm_t) 0x0200000b)

SHA2-512.

Definition at line 853 of file crypto_values.h.

◆ PSA_ALG_SHA_512_224

#define PSA_ALG_SHA_512_224   ((psa_algorithm_t) 0x0200000c)

SHA2-512/224.

Definition at line 855 of file crypto_values.h.

◆ PSA_ALG_SHA_512_256

#define PSA_ALG_SHA_512_256   ((psa_algorithm_t) 0x0200000d)

SHA2-512/256.

Definition at line 857 of file crypto_values.h.

◆ PSA_ALG_SHAKE256_512

#define PSA_ALG_SHAKE256_512   ((psa_algorithm_t) 0x02000015)

The first 512 bits (64 bytes) of the SHAKE256 output.

This is the prehashing for Ed448ph (see PSA_ALG_ED448PH). For other scenarios where a hash function based on SHA3/SHAKE is desired, SHA3-512 has the same output size and a (theoretically) higher security strength.

Definition at line 872 of file crypto_values.h.

◆ PSA_ALG_SIGN_GET_HASH

#define PSA_ALG_SIGN_GET_HASH (   alg)
Value:

Get the hash used by a hash-and-sign signature algorithm.

A hash-and-sign algorithm is a signature algorithm which is composed of two phases: first a hashing phase which does not use the key and produces a hash of the input message, then a signing phase which only uses the hash and the key and not the message itself.

Parameters
algA signature algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_SIGN(alg) is true).
Returns
The underlying hash algorithm if alg is a hash-and-sign algorithm.
0 if alg is a signature algorithm that does not follow the hash-and-sign structure.
Unspecified if alg is not a signature algorithm or if it is not supported by the implementation.

Definition at line 1668 of file crypto_values.h.

◆ PSA_ALG_STREAM_CIPHER

#define PSA_ALG_STREAM_CIPHER   ((psa_algorithm_t) 0x04800100)

The stream cipher mode of a stream cipher algorithm.

The underlying stream cipher is determined by the key type.

Definition at line 1103 of file crypto_values.h.

◆ PSA_ALG_TLS12_PRF

#define PSA_ALG_TLS12_PRF (   hash_alg)     (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Macro to build a TLS-1.2 PRF algorithm.

TLS 1.2 uses a custom pseudorandom function (PRF) for key schedule, specified in Section 5 of RFC 5246. It is based on HMAC and can be used with either SHA-256 or SHA-384.

This key derivation algorithm uses the following inputs, which must be passed in the order given here:

For the application to TLS-1.2 key expansion, the seed is the concatenation of ServerHello.Random + ClientHello.Random, and the label is "key expansion".

For example, `PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256)` represents the TLS 1.2 PRF using HMAC-SHA-256.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true).
Returns
The corresponding TLS-1.2 PRF algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1767 of file crypto_values.h.

◆ PSA_ALG_TLS12_PRF_BASE

#define PSA_ALG_TLS12_PRF_BASE   ((psa_algorithm_t) 0x08000200)

Definition at line 1740 of file crypto_values.h.

◆ PSA_ALG_TLS12_PRF_GET_HASH

#define PSA_ALG_TLS12_PRF_GET_HASH (   hkdf_alg)     (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))

Definition at line 1780 of file crypto_values.h.

◆ PSA_ALG_TLS12_PSK_TO_MS

#define PSA_ALG_TLS12_PSK_TO_MS (   hash_alg)     (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))

Macro to build a TLS-1.2 PSK-to-MasterSecret algorithm.

In a pure-PSK handshake in TLS 1.2, the master secret is derived from the PreSharedKey (PSK) through the application of padding (RFC 4279, Section 2) and the TLS-1.2 PRF (RFC 5246, Section 5). The latter is based on HMAC and can be used with either SHA-256 or SHA-384.

This key derivation algorithm uses the following inputs, which must be passed in the order given here:

For the application to TLS-1.2, the seed (which is forwarded to the TLS-1.2 PRF) is the concatenation of the ClientHello.Random + ServerHello.Random, and the label is "master secret" or "extended master secret".

For example, `PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256)` represents the TLS-1.2 PSK to MasterSecret derivation PRF using HMAC-SHA-256.

Parameters
hash_algA hash algorithm (PSA_ALG_XXX value such that PSA_ALG_IS_HASH(hash_alg) is true).
Returns
The corresponding TLS-1.2 PSK to MS algorithm.
Unspecified if hash_alg is not a supported hash algorithm.

Definition at line 1813 of file crypto_values.h.

◆ PSA_ALG_TLS12_PSK_TO_MS_BASE

#define PSA_ALG_TLS12_PSK_TO_MS_BASE   ((psa_algorithm_t) 0x08000300)

Definition at line 1783 of file crypto_values.h.

◆ PSA_ALG_TLS12_PSK_TO_MS_GET_HASH

#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH (   hkdf_alg)     (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))

Definition at line 1826 of file crypto_values.h.

◆ PSA_ALG_TRUNCATED_MAC

#define PSA_ALG_TRUNCATED_MAC (   mac_alg,
  mac_length 
)
Value:

Macro to build a truncated MAC algorithm.

A truncated MAC algorithm is identical to the corresponding MAC algorithm except that the MAC value for the truncated algorithm consists of only the first mac_length bytes of the MAC value for the untruncated algorithm.

Note
This macro may allow constructing algorithm identifiers that are not valid, either because the specified length is larger than the untruncated MAC or because the specified length is smaller than permitted by the implementation.
It is implementation-defined whether a truncated MAC that is truncated to the same length as the MAC of the untruncated algorithm is considered identical to the untruncated algorithm for policy comparison purposes.
Parameters
mac_algA MAC algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_MAC(mac_alg) is true). This may be a truncated or untruncated MAC algorithm.
mac_lengthDesired length of the truncated MAC in bytes. This must be at most the full length of the MAC and must be at least an implementation-specified minimum. The implementation-specified minimum shall not be zero.
Returns
The corresponding MAC algorithm with the specified length.
Unspecified if mac_alg is not a supported MAC algorithm or if mac_length is too small or too large for the specified MAC algorithm.

Definition at line 993 of file crypto_values.h.

◆ PSA_ALG_VENDOR_FLAG

#define PSA_ALG_VENDOR_FLAG   ((psa_algorithm_t) 0x80000000)

Vendor-defined algorithm flag.

Algorithms defined by this standard will never have the PSA_ALG_VENDOR_FLAG bit set. Vendors who define additional algorithms must use an encoding with the PSA_ALG_VENDOR_FLAG bit set and should respect the bitwise structure used by standard encodings whenever practical.

Definition at line 720 of file crypto_values.h.

◆ PSA_ALG_XTS

#define PSA_ALG_XTS   ((psa_algorithm_t) 0x0440ff00)

The XTS cipher mode.

XTS is a cipher mode which is built from a block cipher. It requires at least one full block of input, but beyond this minimum the input does not need to be a whole number of blocks.

Definition at line 1132 of file crypto_values.h.

◆ PSA_BLOCK_CIPHER_BLOCK_LENGTH

#define PSA_BLOCK_CIPHER_BLOCK_LENGTH (   type)
Value:
0u)
static int type
Definition: getdata.c:31
#define PSA_KEY_TYPE_CATEGORY_MASK
#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC
#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type)
Definition: type.c:6

The block size of a block cipher.

Parameters
typeA cipher key type (value of type psa_key_type_t).
Returns
The block size for a block cipher, or 1 for a stream cipher. The return value is undefined if type is not a supported cipher key type.
Note
It is possible to build stream cipher algorithms on top of a block cipher, for example CTR mode (PSA_ALG_CTR). This macro only takes the key type into account, so it cannot be used to determine the size of the data that psa_cipher_update() might buffer for future processing in general.
This macro returns a compile-time constant if its argument is one.
Warning
This macro may evaluate its argument multiple times.

Definition at line 703 of file crypto_values.h.

◆ PSA_DH_FAMILY_RFC7919

#define PSA_DH_FAMILY_RFC7919   ((psa_dh_family_t) 0x03)

Diffie-Hellman groups defined in RFC 7919 Appendix A.

This family includes groups with the following key sizes (in bits): 2048, 3072, 4096, 6144, 8192. A given implementation may support all of these sizes or only a subset.

Definition at line 681 of file crypto_values.h.

◆ PSA_ECC_FAMILY_BRAINPOOL_P_R1

#define PSA_ECC_FAMILY_BRAINPOOL_P_R1   ((psa_ecc_family_t) 0x30)

Brainpool P random curves.

This family comprises the following curves: brainpoolP160r1, brainpoolP192r1, brainpoolP224r1, brainpoolP256r1, brainpoolP320r1, brainpoolP384r1, brainpoolP512r1. It is defined in RFC 5639.

Definition at line 608 of file crypto_values.h.

◆ PSA_ECC_FAMILY_MONTGOMERY

#define PSA_ECC_FAMILY_MONTGOMERY   ((psa_ecc_family_t) 0x41)

Curve25519 and Curve448.

This family comprises the following Montgomery curves:

  • 255-bit: Bernstein et al., _Curve25519: new Diffie-Hellman speed records_, LNCS 3958, 2006. The algorithm PSA_ALG_ECDH performs X25519 when used with this curve.
  • 448-bit: Hamburg, _Ed448-Goldilocks, a new elliptic curve_, NIST ECC Workshop, 2015. The algorithm PSA_ALG_ECDH performs X448 when used with this curve.

Definition at line 620 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECP_K1

#define PSA_ECC_FAMILY_SECP_K1   ((psa_ecc_family_t) 0x17)

SEC Koblitz curves over prime fields.

This family comprises the following curves: secp192k1, secp224k1, secp256k1. They are defined in _Standards for Efficient Cryptography_, _SEC 2: Recommended Elliptic Curve Domain Parameters_. https://www.secg.org/sec2-v2.pdf

Definition at line 557 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECP_R1

#define PSA_ECC_FAMILY_SECP_R1   ((psa_ecc_family_t) 0x12)

SEC random curves over prime fields.

This family comprises the following curves: secp192k1, secp224r1, secp256r1, secp384r1, secp521r1. They are defined in _Standards for Efficient Cryptography_, _SEC 2: Recommended Elliptic Curve Domain Parameters_. https://www.secg.org/sec2-v2.pdf

Definition at line 567 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECP_R2

#define PSA_ECC_FAMILY_SECP_R2   ((psa_ecc_family_t) 0x1b)

Definition at line 569 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECT_K1

#define PSA_ECC_FAMILY_SECT_K1   ((psa_ecc_family_t) 0x27)

SEC Koblitz curves over binary fields.

This family comprises the following curves: sect163k1, sect233k1, sect239k1, sect283k1, sect409k1, sect571k1. They are defined in _Standards for Efficient Cryptography_, _SEC 2: Recommended Elliptic Curve Domain Parameters_. https://www.secg.org/sec2-v2.pdf

Definition at line 579 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECT_R1

#define PSA_ECC_FAMILY_SECT_R1   ((psa_ecc_family_t) 0x22)

SEC random curves over binary fields.

This family comprises the following curves: sect163r1, sect233r1, sect283r1, sect409r1, sect571r1. They are defined in _Standards for Efficient Cryptography_, _SEC 2: Recommended Elliptic Curve Domain Parameters_. https://www.secg.org/sec2-v2.pdf

Definition at line 589 of file crypto_values.h.

◆ PSA_ECC_FAMILY_SECT_R2

#define PSA_ECC_FAMILY_SECT_R2   ((psa_ecc_family_t) 0x2b)

SEC additional random curves over binary fields.

This family comprises the following curve: sect163r2. It is defined in _Standards for Efficient Cryptography_, _SEC 2: Recommended Elliptic Curve Domain Parameters_. https://www.secg.org/sec2-v2.pdf

Definition at line 599 of file crypto_values.h.

◆ PSA_ECC_FAMILY_TWISTED_EDWARDS

#define PSA_ECC_FAMILY_TWISTED_EDWARDS   ((psa_ecc_family_t) 0x42)

The twisted Edwards curves Ed25519 and Ed448.

These curves are suitable for EdDSA (PSA_ALG_PURE_EDDSA for both curves, PSA_ALG_ED25519PH for the 255-bit curve, PSA_ALG_ED448PH for the 448-bit curve).

This family comprises the following twisted Edwards curves:

  • 255-bit: Edwards25519, the twisted Edwards curve birationally equivalent to Curve25519. Bernstein et al., _Twisted Edwards curves_, Africacrypt 2008.
  • 448-bit: Edwards448, the twisted Edwards curve birationally equivalent to Curve448. Hamburg, _Ed448-Goldilocks, a new elliptic curve_, NIST ECC Workshop, 2015.

Definition at line 636 of file crypto_values.h.

◆ PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT

#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT (   type)     (((type) >> 8) & 7)

Definition at line 683 of file crypto_values.h.

◆ PSA_KEY_TYPE_AES

#define PSA_KEY_TYPE_AES   ((psa_key_type_t) 0x2400)

Key for a cipher, AEAD or MAC algorithm based on the AES block cipher.

The size of the key can be 16 bytes (AES-128), 24 bytes (AES-192) or 32 bytes (AES-256).

Definition at line 454 of file crypto_values.h.

◆ PSA_KEY_TYPE_ARC4

#define PSA_KEY_TYPE_ARC4   ((psa_key_type_t) 0x2002)

Key for the ARC4 stream cipher (also known as RC4 or ARCFOUR).

Note that ARC4 is weak and deprecated and should only be used in legacy protocols.

Definition at line 479 of file crypto_values.h.

◆ PSA_KEY_TYPE_ARIA

#define PSA_KEY_TYPE_ARIA   ((psa_key_type_t) 0x2406)

Key for a cipher, AEAD or MAC algorithm based on the ARIA block cipher.

Definition at line 458 of file crypto_values.h.

◆ PSA_KEY_TYPE_CAMELLIA

#define PSA_KEY_TYPE_CAMELLIA   ((psa_key_type_t) 0x2403)

Key for a cipher, AEAD or MAC algorithm based on the Camellia block cipher.

Definition at line 473 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_FLAG_PAIR

#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR   ((psa_key_type_t) 0x3000)

Definition at line 372 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_KEY_PAIR

#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR   ((psa_key_type_t) 0x7000)

Definition at line 370 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_MASK

#define PSA_KEY_TYPE_CATEGORY_MASK   ((psa_key_type_t) 0x7000)

Definition at line 366 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY

#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY   ((psa_key_type_t) 0x4000)

Definition at line 369 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_RAW

#define PSA_KEY_TYPE_CATEGORY_RAW   ((psa_key_type_t) 0x1000)

Definition at line 367 of file crypto_values.h.

◆ PSA_KEY_TYPE_CATEGORY_SYMMETRIC

#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC   ((psa_key_type_t) 0x2000)

Definition at line 368 of file crypto_values.h.

◆ PSA_KEY_TYPE_CHACHA20

#define PSA_KEY_TYPE_CHACHA20   ((psa_key_type_t) 0x2004)

Key for the ChaCha20 stream cipher or the Chacha20-Poly1305 AEAD algorithm.

ChaCha20 and the ChaCha20_Poly1305 construction are defined in RFC 7539.

Implementations must support 12-byte nonces, may support 8-byte nonces, and should reject other sizes.

Definition at line 488 of file crypto_values.h.

◆ PSA_KEY_TYPE_DERIVE

#define PSA_KEY_TYPE_DERIVE   ((psa_key_type_t) 0x1200)

A secret for key derivation.

The key policy determines which key derivation algorithm the key can be used for.

Definition at line 447 of file crypto_values.h.

◆ PSA_KEY_TYPE_DES

#define PSA_KEY_TYPE_DES   ((psa_key_type_t) 0x2301)

Key for a cipher or MAC algorithm based on DES or 3DES (Triple-DES).

The size of the key can be 64 bits (single DES), 128 bits (2-key 3DES) or 192 bits (3-key 3DES).

Note that single DES and 2-key 3DES are weak and strongly deprecated and should only be used to decrypt legacy data. 3-key 3DES is weak and deprecated and should only be used in legacy protocols.

Definition at line 469 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_GET_FAMILY

#define PSA_KEY_TYPE_DH_GET_FAMILY (   type)
Value:
0))
#define PSA_KEY_TYPE_DH_GROUP_MASK
#define PSA_KEY_TYPE_IS_DH(type)
Whether a key type is a Diffie-Hellman key (pair or public-only).
uint8_t psa_dh_family_t
The type of PSA Diffie-Hellman group family identifiers.
Definition: crypto_types.h:119

Extract the group from a Diffie-Hellman key type.

Definition at line 670 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_GROUP_MASK

#define PSA_KEY_TYPE_DH_GROUP_MASK   ((psa_key_type_t) 0x00ff)

Definition at line 640 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_KEY_PAIR

#define PSA_KEY_TYPE_DH_KEY_PAIR (   group)     (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))

Diffie-Hellman key pair.

Parameters
groupA value of type psa_dh_family_t that identifies the Diffie-Hellman group to be used.

Definition at line 646 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_KEY_PAIR_BASE

#define PSA_KEY_TYPE_DH_KEY_PAIR_BASE   ((psa_key_type_t) 0x7200)

Definition at line 639 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_PUBLIC_KEY

#define PSA_KEY_TYPE_DH_PUBLIC_KEY (   group)     (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))

Diffie-Hellman public key.

Parameters
groupA value of type psa_dh_family_t that identifies the Diffie-Hellman group to be used.

Definition at line 653 of file crypto_values.h.

◆ PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE

#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE   ((psa_key_type_t) 0x4200)

Definition at line 638 of file crypto_values.h.

◆ PSA_KEY_TYPE_DSA_KEY_PAIR

#define PSA_KEY_TYPE_DSA_KEY_PAIR   ((psa_key_type_t) 0x7002)

DSA key pair (private and public key).

The import and export format is the representation of the private key `x` as a big-endian byte string. The length of the byte string is the private key size in bytes (leading zeroes are not stripped).

Deterministic DSA key derivation with psa_generate_derived_key follows FIPS 186-4 §B.1.2: interpret the byte string as integer in big-endian order. Discard it if it is not in the range [0, *N* - 2] where *N* is the boundary of the private key domain (the prime *p* for Diffie-Hellman, the subprime *q* for DSA, or the order of the curve's base point for ECC). Add 1 to the resulting integer and use this as the private key *x*.

Definition at line 356 of file crypto_extra.h.

◆ PSA_KEY_TYPE_DSA_PUBLIC_KEY

#define PSA_KEY_TYPE_DSA_PUBLIC_KEY   ((psa_key_type_t) 0x4002)

DSA public key.

The import and export format is the representation of the public key `y = g^x mod p` as a big-endian byte string. The length of the byte string is the length of the base prime `p` in bytes.

Definition at line 338 of file crypto_extra.h.

◆ PSA_KEY_TYPE_ECC_CURVE_MASK

#define PSA_KEY_TYPE_ECC_CURVE_MASK   ((psa_key_type_t) 0x00ff)

Definition at line 506 of file crypto_values.h.

◆ PSA_KEY_TYPE_ECC_GET_FAMILY

#define PSA_KEY_TYPE_ECC_GET_FAMILY (   type)
Value:
0))
#define PSA_KEY_TYPE_IS_ECC(type)
Whether a key type is an elliptic curve key (pair or public-only).
#define PSA_KEY_TYPE_ECC_CURVE_MASK
uint8_t psa_ecc_family_t
The type of PSA elliptic curve family identifiers.
Definition: crypto_types.h:100

Extract the curve from an elliptic curve key type.

Definition at line 544 of file crypto_values.h.

◆ PSA_KEY_TYPE_ECC_KEY_PAIR

#define PSA_KEY_TYPE_ECC_KEY_PAIR (   curve)     (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))

Elliptic curve key pair.

The size of an elliptic curve key is the bit size associated with the curve, i.e. the bit size of *q* for a curve over a field *Fq*. See the documentation of `PSA_ECC_FAMILY_xxx` curve families for details.

Parameters
curveA value of type psa_ecc_family_t that identifies the ECC curve to be used.

Definition at line 516 of file crypto_values.h.

◆ PSA_KEY_TYPE_ECC_KEY_PAIR_BASE

#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE   ((psa_key_type_t) 0x7100)

Definition at line 505 of file crypto_values.h.

◆ PSA_KEY_TYPE_ECC_PUBLIC_KEY

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY (   curve)     (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))

Elliptic curve public key.

The size of an elliptic curve public key is the same as the corresponding private key (see PSA_KEY_TYPE_ECC_KEY_PAIR and the documentation of `PSA_ECC_FAMILY_xxx` curve families).

Parameters
curveA value of type psa_ecc_family_t that identifies the ECC curve to be used.

Definition at line 527 of file crypto_values.h.

◆ PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE   ((psa_key_type_t) 0x4100)

Definition at line 504 of file crypto_values.h.

◆ PSA_KEY_TYPE_HMAC

#define PSA_KEY_TYPE_HMAC   ((psa_key_type_t) 0x1100)

HMAC key.

The key policy determines which underlying hash algorithm the key can be used for.

HMAC keys should generally have the same size as the underlying hash. This size can be calculated with PSA_HASH_LENGTH(alg) where alg is the HMAC algorithm or the underlying hash algorithm.

Definition at line 440 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_ASYMMETRIC

#define PSA_KEY_TYPE_IS_ASYMMETRIC (   type)
Value:
PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR

Whether a key type is asymmetric: either a key pair or a public key.

Definition at line 390 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_DH

#define PSA_KEY_TYPE_IS_DH (   type)
Value:
~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE
#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type)
The public key type corresponding to a key pair type.

Whether a key type is a Diffie-Hellman key (pair or public-only).

Definition at line 657 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_DH_KEY_PAIR

#define PSA_KEY_TYPE_IS_DH_KEY_PAIR (   type)
Value:
PSA_KEY_TYPE_DH_KEY_PAIR_BASE)

Whether a key type is a Diffie-Hellman key pair.

Definition at line 661 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_DH_PUBLIC_KEY

#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY (   type)
Value:
PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)

Whether a key type is a Diffie-Hellman public key.

Definition at line 665 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_DSA

#define PSA_KEY_TYPE_IS_DSA (   type)     (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_DSA_PUBLIC_KEY)

Whether a key type is a DSA key (pair or public-only).

Definition at line 359 of file crypto_extra.h.

◆ PSA_KEY_TYPE_IS_ECC

#define PSA_KEY_TYPE_IS_ECC (   type)
Value:
~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE

Whether a key type is an elliptic curve key (pair or public-only).

Definition at line 531 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_ECC_KEY_PAIR

#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR (   type)
Value:
PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)

Whether a key type is an elliptic curve key pair.

Definition at line 535 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY

#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY (   type)
Value:
PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)

Whether a key type is an elliptic curve public key.

Definition at line 539 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_KEY_PAIR

#define PSA_KEY_TYPE_IS_KEY_PAIR (   type)     (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)

Whether a key type is a key pair containing a private part and a public part.

Definition at line 399 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_PUBLIC_KEY

#define PSA_KEY_TYPE_IS_PUBLIC_KEY (   type)     (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)

Whether a key type is the public part of a key pair.

Definition at line 395 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_RSA

#define PSA_KEY_TYPE_IS_RSA (   type)     (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)

Whether a key type is an RSA key (pair or public-only).

Definition at line 501 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_UNSTRUCTURED

#define PSA_KEY_TYPE_IS_UNSTRUCTURED (   type)
Value:

Whether a key type is an unstructured array of bytes.

This encompasses both symmetric keys and non-key data.

Definition at line 385 of file crypto_values.h.

◆ PSA_KEY_TYPE_IS_VENDOR_DEFINED

#define PSA_KEY_TYPE_IS_VENDOR_DEFINED (   type)     (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)

Whether a key type is vendor-defined.

See also PSA_KEY_TYPE_VENDOR_FLAG.

Definition at line 378 of file crypto_values.h.

◆ PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY

#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY (   type)     ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)

The key pair type corresponding to a public key type.

You may also pass a key pair type as type, it will be left unchanged.

Parameters
typeA public key type or key pair type.
Returns
The corresponding key pair type. If type is not a public key or a key pair, the return value is undefined.

Definition at line 411 of file crypto_values.h.

◆ PSA_KEY_TYPE_NONE

#define PSA_KEY_TYPE_NONE   ((psa_key_type_t) 0x0000)

An invalid key type value.

Zero is not the encoding of any key type.

Definition at line 355 of file crypto_values.h.

◆ PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR

#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR (   type)     ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)

The public key type corresponding to a key pair type.

You may also pass a key pair type as type, it will be left unchanged.

Parameters
typeA public key type or key pair type.
Returns
The corresponding public key type. If type is not a public key or a key pair, the return value is undefined.

Definition at line 423 of file crypto_values.h.

◆ PSA_KEY_TYPE_RAW_DATA

#define PSA_KEY_TYPE_RAW_DATA   ((psa_key_type_t) 0x1001)

Raw data.

A "key" of this type cannot be used for any cryptographic operation. Applications may use this type to store arbitrary data in the keystore.

Definition at line 430 of file crypto_values.h.

◆ PSA_KEY_TYPE_RSA_KEY_PAIR

#define PSA_KEY_TYPE_RSA_KEY_PAIR   ((psa_key_type_t) 0x7001)

RSA key pair (private and public key).

The size of an RSA key is the bit size of the modulus.

Definition at line 499 of file crypto_values.h.

◆ PSA_KEY_TYPE_RSA_PUBLIC_KEY

#define PSA_KEY_TYPE_RSA_PUBLIC_KEY   ((psa_key_type_t) 0x4001)

RSA public key.

The size of an RSA key is the bit size of the modulus.

Definition at line 494 of file crypto_values.h.

◆ PSA_KEY_TYPE_VENDOR_FLAG

#define PSA_KEY_TYPE_VENDOR_FLAG   ((psa_key_type_t) 0x8000)

Vendor-defined key type flag.

Key types defined by this standard will never have the PSA_KEY_TYPE_VENDOR_FLAG bit set. Vendors who define additional key types must use an encoding with the PSA_KEY_TYPE_VENDOR_FLAG bit set and should respect the bitwise structure used by standard encodings whenever practical.

Definition at line 364 of file crypto_values.h.

◆ PSA_MAC_TRUNCATED_LENGTH

#define PSA_MAC_TRUNCATED_LENGTH (   mac_alg)     (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)

Length to which a MAC algorithm is truncated.

Parameters
mac_algA MAC algorithm identifier (value of type psa_algorithm_t such that PSA_ALG_IS_MAC(mac_alg) is true).
Returns
Length of the truncated MAC in bytes.
0 if mac_alg is a non-truncated MAC algorithm.
Unspecified if mac_alg is not a supported MAC algorithm.

Definition at line 1025 of file crypto_values.h.

◆ PSA_MAC_TRUNCATION_OFFSET

#define PSA_MAC_TRUNCATION_OFFSET   16

Definition at line 950 of file crypto_values.h.

Typedef Documentation

◆ psa_algorithm_t

Encoding of a cryptographic algorithm.

Values of this type are generally constructed by macros called `PSA_ALG_xxx`.

For algorithms that can be applied to multiple key types, this type does not encode the key type. For example, for symmetric ciphers based on a block cipher, psa_algorithm_t encodes the block cipher mode and the padding mode while the block cipher itself is encoded via psa_key_type_t.

Note
Values of this type are encoded in the persistent key store. Any changes to existing values will require bumping the storage format version and providing a translation when reading the old format.

Definition at line 137 of file crypto_types.h.

◆ psa_dh_family_t

The type of PSA Diffie-Hellman group family identifiers.

Values of this type are generally constructed by macros called `PSA_DH_FAMILY_xxx`.

The group identifier is required to create a Diffie-Hellman key using the PSA_KEY_TYPE_DH_KEY_PAIR() or PSA_KEY_TYPE_DH_PUBLIC_KEY() macros.

Values defined by this standard will never be in the range 0x80-0xff. Vendors who define additional families must use an encoding in this range.

Note
Values of this type are encoded in the persistent key store. Any changes to existing values will require bumping the storage format version and providing a translation when reading the old format.

Definition at line 119 of file crypto_types.h.

◆ psa_ecc_family_t

The type of PSA elliptic curve family identifiers.

Values of this type are generally constructed by macros called `PSA_ECC_FAMILY_xxx`.

The curve identifier is required to create an ECC key using the PSA_KEY_TYPE_ECC_KEY_PAIR() or PSA_KEY_TYPE_ECC_PUBLIC_KEY() macros.

Values defined by this standard will never be in the range 0x80-0xff. Vendors who define additional families must use an encoding in this range.

Note
Values of this type are encoded in the persistent key store. Any changes to existing values will require bumping the storage format version and providing a translation when reading the old format.

Definition at line 100 of file crypto_types.h.

◆ psa_key_type_t

Encoding of a key type.

Values of this type are generally constructed by macros called `PSA_KEY_TYPE_xxx`.

Note
Values of this type are encoded in the persistent key store. Any changes to existing values will require bumping the storage format version and providing a translation when reading the old format.

Definition at line 81 of file crypto_types.h.

Modified on Fri Jan 05 07:26:08 2024 by modify_doxy.py rev. 669887