Key and algorithm types#

Typedefs#

typedef uint16_t

Encoding of a key type.

typedef uint8_t

The type of PSA elliptic curve family identifiers.

typedef uint8_t

The type of PSA Diffie-Hellman group family identifiers.

typedef uint32_t

Encoding of a cryptographic algorithm.

typedef uint16_t

Encoding of a key type.

typedef uint8_t

The type of PSA elliptic curve family identifiers.

typedef uint8_t

The type of PSA Diffie-Hellman group family identifiers.

typedef uint32_t

Encoding of a cryptographic algorithm.

Macros#

#define
PSA_KEY_TYPE_DSA_PUBLIC_KEY ((psa_key_type_t)0x4002)

DSA public key.

#define
PSA_KEY_TYPE_DSA_KEY_PAIR ((psa_key_type_t)0x7002)

DSA key pair (private and public key).

#define

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

#define
PSA_ALG_DSA_BASE ((psa_algorithm_t)0x06000400)
#define
PSA_ALG_DSA (hash_alg)

DSA signature with hashing.

#define
PSA_ALG_DETERMINISTIC_DSA_BASE ((psa_algorithm_t)0x06000500)
#define
PSA_ALG_DSA_DETERMINISTIC_FLAG PSA_ALG_ECDSA_DETERMINISTIC_FLAG
#define

Deterministic DSA signature with hashing.

#define
#define
PSA_ALG_CATEGORY_PAKE ((psa_algorithm_t) 0x0a000000)
#define

Whether the specified algorithm is a password-authenticated key exchange.

#define
PSA_ALG_JPAKE ((psa_algorithm_t) 0x0a000100)

The Password-authenticated key exchange by juggling (J-PAKE) algorithm.

#define
PSA_KEY_TYPE_NONE ((psa_key_type_t) 0x0000)

An invalid key type value.

#define
PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t) 0x8000)

Vendor-defined key type flag.

#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

Whether a key type is vendor-defined.

#define

Whether a key type is an unstructured array of bytes.

#define

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

#define

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

#define

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

#define

The key pair type corresponding to a public key type.

#define

The public key type corresponding to a key pair type.

#define
PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t) 0x1001)

Raw data.

#define
PSA_KEY_TYPE_HMAC ((psa_key_type_t) 0x1100)

HMAC key.

#define
PSA_KEY_TYPE_DERIVE ((psa_key_type_t) 0x1200)

A secret for key derivation.

#define
PSA_KEY_TYPE_PASSWORD ((psa_key_type_t) 0x1203)

A low-entropy secret for password hashing or key derivation.

#define
PSA_KEY_TYPE_PASSWORD_HASH ((psa_key_type_t) 0x1205)

A secret value that can be used to verify a password hash.

#define
PSA_KEY_TYPE_PEPPER ((psa_key_type_t) 0x1206)

A secret value that can be used in when computing a password hash.

#define
PSA_KEY_TYPE_AES ((psa_key_type_t) 0x2400)

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

#define
PSA_KEY_TYPE_ARIA ((psa_key_type_t) 0x2406)

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

#define
PSA_KEY_TYPE_DES ((psa_key_type_t) 0x2301)

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

#define
PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t) 0x2403)

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

#define
PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t) 0x2004)

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

#define
PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t) 0x4001)

RSA public key.

#define
PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t) 0x7001)

RSA key pair (private and public key).

#define

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

#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

Elliptic curve key pair.

#define

Elliptic curve public key.

#define

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

#define

Whether a key type is an elliptic curve key pair.

#define

Whether a key type is an elliptic curve public key.

#define

Extract the curve from an elliptic curve key type.

#define

Check if the curve of given family is Weierstrass elliptic curve.

#define
PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)

SEC Koblitz curves over prime fields.

#define
PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)

SEC random curves over prime fields.

#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.

#define
PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)

SEC random curves over binary fields.

#define
PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)

SEC additional random curves over binary fields.

#define
PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)

Brainpool P random curves.

#define
PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)

Curve25519 and Curve448.

#define
PSA_ECC_FAMILY_TWISTED_EDWARDS ((psa_ecc_family_t) 0x42)

The twisted Edwards curves Ed25519 and Ed448.

#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

Diffie-Hellman key pair.

#define

Diffie-Hellman public key.

#define

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

#define

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

#define

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

#define

Extract the group from a Diffie-Hellman key type.

#define
PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)

Diffie-Hellman groups defined in RFC 7919 Appendix A.

#define

The block size of a block cipher.

#define
PSA_ALG_VENDOR_FLAG ((psa_algorithm_t) 0x80000000)

Vendor-defined algorithm flag.

#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

Whether an algorithm is vendor-defined.

#define

Whether the specified algorithm is a hash algorithm.

#define

Whether the specified algorithm is a MAC algorithm.

#define

Whether the specified algorithm is a symmetric cipher algorithm.

#define

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

#define

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

#define

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

#define

Whether the specified algorithm is a key agreement algorithm.

#define

Whether the specified algorithm is a key derivation algorithm.

#define

Whether the specified algorithm is a key stretching / password hashing algorithm.

#define
PSA_ALG_NONE ((psa_algorithm_t)0)

An invalid algorithm identifier value.

#define
PSA_ALG_HASH_MASK ((psa_algorithm_t) 0x000000ff)
#define
PSA_ALG_MD5 ((psa_algorithm_t) 0x02000003)

MD5.

#define
PSA_ALG_RIPEMD160 ((psa_algorithm_t) 0x02000004)

PSA_ALG_RIPEMD160.

#define
PSA_ALG_SHA_1 ((psa_algorithm_t) 0x02000005)

SHA1.

#define
PSA_ALG_SHA_224 ((psa_algorithm_t) 0x02000008)

SHA2-224.

#define
PSA_ALG_SHA_256 ((psa_algorithm_t) 0x02000009)

SHA2-256.

#define
PSA_ALG_SHA_384 ((psa_algorithm_t) 0x0200000a)

SHA2-384.

#define
PSA_ALG_SHA_512 ((psa_algorithm_t) 0x0200000b)

SHA2-512.

#define
PSA_ALG_SHA_512_224 ((psa_algorithm_t) 0x0200000c)

SHA2-512/224.

#define
PSA_ALG_SHA_512_256 ((psa_algorithm_t) 0x0200000d)

SHA2-512/256.

#define
PSA_ALG_SHA3_224 ((psa_algorithm_t) 0x02000010)

SHA3-224.

#define
PSA_ALG_SHA3_256 ((psa_algorithm_t) 0x02000011)

SHA3-256.

#define
PSA_ALG_SHA3_384 ((psa_algorithm_t) 0x02000012)

SHA3-384.

#define
PSA_ALG_SHA3_512 ((psa_algorithm_t) 0x02000013)

SHA3-512.

#define
PSA_ALG_SHAKE256_512 ((psa_algorithm_t) 0x02000015)

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

#define
PSA_ALG_ANY_HASH ((psa_algorithm_t) 0x020000ff)

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

#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)

Macro to build an HMAC algorithm.

#define
#define

Whether the specified algorithm is an HMAC algorithm.

#define
PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t) 0x003f0000)
#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.

#define

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

#define

Length to which a MAC algorithm is truncated.

#define
PSA_ALG_AT_LEAST_THIS_LENGTH_MAC (mac_alg, min_mac_length)

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

#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.

#define
PSA_ALG_CMAC ((psa_algorithm_t) 0x03c00200)

The CMAC construction over a block cipher.

#define

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

#define
PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t) 0x00800000)
#define
PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
#define

Whether the specified algorithm is a stream cipher.

#define
PSA_ALG_STREAM_CIPHER ((psa_algorithm_t) 0x04800100)

The stream cipher mode of a stream cipher algorithm.

#define
PSA_ALG_CTR ((psa_algorithm_t) 0x04c01000)

The CTR stream cipher mode.

#define
PSA_ALG_CFB ((psa_algorithm_t) 0x04c01100)

The CFB stream cipher mode.

#define
PSA_ALG_OFB ((psa_algorithm_t) 0x04c01200)

The OFB stream cipher mode.

#define
PSA_ALG_XTS ((psa_algorithm_t) 0x0440ff00)

The XTS cipher mode.

#define
PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t) 0x04404400)

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

#define
PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t) 0x04404000)

The CBC block cipher chaining mode, with no padding.

#define
PSA_ALG_CBC_PKCS7 ((psa_algorithm_t) 0x04404100)

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

#define
PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
#define

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

#define
PSA_ALG_CCM ((psa_algorithm_t) 0x05500100)

The CCM authenticated encryption algorithm.

#define
PSA_ALG_CCM_STAR_NO_TAG ((psa_algorithm_t) 0x04c01300)

The CCM* cipher mode without authentication.

#define
PSA_ALG_GCM ((psa_algorithm_t) 0x05500200)

The GCM authenticated encryption algorithm.

#define
PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t) 0x05100500)

The Chacha20-Poly1305 AEAD algorithm.

#define
PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t) 0x003f0000)
#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.

#define

Retrieve the tag length of a specified AEAD algorithm.

#define

Calculate the corresponding AEAD algorithm with the default tag length.

#define

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

#define
PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t) 0x06000200)
#define

RSA PKCS#1 v1.5 signature with hashing.

#define
PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE

Raw PKCS#1 v1.5 signature.

#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)

RSA PSS signature with hashing.

#define

RSA PSS signature with hashing with relaxed verification.

#define

Whether the specified algorithm is RSA PSS with standard salt.

#define

Whether the specified algorithm is RSA PSS with any salt.

#define

Whether the specified algorithm is RSA PSS.

#define
PSA_ALG_ECDSA_BASE ((psa_algorithm_t) 0x06000600)
#define
PSA_ALG_ECDSA (hash_alg)

ECDSA signature with hashing.

#define
PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE

ECDSA signature without hashing.

#define
PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t) 0x06000700)
#define

Deterministic ECDSA signature with hashing.

#define
PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t) 0x00000100)
#define
#define
PSA_ALG_PURE_EDDSA ((psa_algorithm_t) 0x06000800)

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

#define
PSA_ALG_HASH_EDDSA_BASE ((psa_algorithm_t) 0x06000900)
#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.

#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.

#define

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

#define

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

#define

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

#define

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

#define
PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t) 0x07000200)

RSA PKCS#1 v1.5 encryption.

#define
PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t) 0x07000300)
#define
PSA_ALG_RSA_OAEP (hash_alg)

RSA OAEP encryption.

#define
#define
PSA_ALG_HKDF_BASE ((psa_algorithm_t) 0x08000100)
#define
PSA_ALG_HKDF (hash_alg)

Macro to build an HKDF algorithm.

#define

Whether the specified algorithm is an HKDF algorithm.

#define
#define
PSA_ALG_HKDF_EXTRACT_BASE ((psa_algorithm_t) 0x08000400)
#define

Macro to build an HKDF-Extract algorithm.

#define

Whether the specified algorithm is an HKDF-Extract algorithm.

#define
PSA_ALG_HKDF_EXPAND_BASE ((psa_algorithm_t) 0x08000500)
#define

Macro to build an HKDF-Expand algorithm.

#define

Whether the specified algorithm is an HKDF-Expand algorithm.

#define

Whether the specified algorithm is an HKDF or HKDF-Extract or HKDF-Expand algorithm.

#define
PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t) 0x08000200)
#define

Macro to build a TLS-1.2 PRF algorithm.

#define

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

#define
#define
PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t) 0x08000300)
#define

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

#define

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

#define
PSA_ALG_TLS12_ECJPAKE_TO_PMS ((psa_algorithm_t) 0x08000609)
#define
PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG ((psa_algorithm_t) 0x00800000)
#define
PSA_ALG_PBKDF2_HMAC_BASE ((psa_algorithm_t) 0x08800100)
#define

Macro to build a PBKDF2-HMAC password hashing / key stretching algorithm.

#define

Whether the specified algorithm is a PBKDF2-HMAC algorithm.

#define
#define
PSA_ALG_PBKDF2_AES_CMAC_PRF_128 ((psa_algorithm_t) 0x08800200)

The PBKDF2-AES-CMAC-PRF-128 password hashing / key stretching algorithm.

#define
#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)

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

#define

Whether the specified algorithm is a raw key agreement algorithm.

#define
PSA_ALG_FFDH ((psa_algorithm_t) 0x09010000)

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

#define

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

#define
PSA_ALG_ECDH ((psa_algorithm_t) 0x09020000)

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

#define

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

#define

Whether the specified algorithm encoding is a wildcard.

#define

Get the hash used by a composite algorithm.

#define
PSA_KEY_TYPE_NONE ((psa_key_type_t) 0x0000)

An invalid key type value.

#define
PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t) 0x8000)

Vendor-defined key type flag.

#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

Whether a key type is vendor-defined.

#define

Whether a key type is an unstructured array of bytes.

#define

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

#define

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

#define

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

#define

The key pair type corresponding to a public key type.

#define

The public key type corresponding to a key pair type.

#define
PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t) 0x1001)

Raw data.

#define
PSA_KEY_TYPE_HMAC ((psa_key_type_t) 0x1100)

HMAC key.

#define
PSA_KEY_TYPE_DERIVE ((psa_key_type_t) 0x1200)

A secret for key derivation.

#define
PSA_KEY_TYPE_PASSWORD ((psa_key_type_t) 0x1203)

A low-entropy secret for password hashing or key derivation.

#define
PSA_KEY_TYPE_PASSWORD_HASH ((psa_key_type_t) 0x1205)

A secret value that can be used to verify a password hash.

#define
PSA_KEY_TYPE_PEPPER ((psa_key_type_t) 0x1206)

A secret value that can be used in when computing a password hash.

#define
PSA_KEY_TYPE_AES ((psa_key_type_t) 0x2400)

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

#define
PSA_KEY_TYPE_ARIA ((psa_key_type_t) 0x2406)

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

#define
PSA_KEY_TYPE_DES ((psa_key_type_t) 0x2301)

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

#define
PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t) 0x2403)

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

#define
PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t) 0x2004)

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

#define
PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t) 0x4001)

RSA public key.

#define
PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t) 0x7001)

RSA key pair (private and public key).

#define

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

#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

Elliptic curve key pair.

#define

Elliptic curve public key.

#define

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

#define

Whether a key type is an elliptic curve key pair.

#define

Whether a key type is an elliptic curve public key.

#define

Extract the curve from an elliptic curve key type.

#define

Check if the curve of given family is Weierstrass elliptic curve.

#define
PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)

SEC Koblitz curves over prime fields.

#define
PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)

SEC random curves over prime fields.

#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.

#define
PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)

SEC random curves over binary fields.

#define
PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)

SEC additional random curves over binary fields.

#define
PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)

Brainpool P random curves.

#define
PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)

Curve25519 and Curve448.

#define
PSA_ECC_FAMILY_TWISTED_EDWARDS ((psa_ecc_family_t) 0x42)

The twisted Edwards curves Ed25519 and Ed448.

#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

Diffie-Hellman key pair.

#define

Diffie-Hellman public key.

#define

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

#define

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

#define

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

#define

Extract the group from a Diffie-Hellman key type.

#define
PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)

Diffie-Hellman groups defined in RFC 7919 Appendix A.

#define

The block size of a block cipher.

#define
PSA_ALG_VENDOR_FLAG ((psa_algorithm_t) 0x80000000)

Vendor-defined algorithm flag.

#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

Whether an algorithm is vendor-defined.

#define

Whether the specified algorithm is a hash algorithm.

#define

Whether the specified algorithm is a MAC algorithm.

#define

Whether the specified algorithm is a symmetric cipher algorithm.

#define

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

#define

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

#define

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

#define

Whether the specified algorithm is a key agreement algorithm.

#define

Whether the specified algorithm is a key derivation algorithm.

#define

Whether the specified algorithm is a key stretching / password hashing algorithm.

#define
PSA_ALG_NONE ((psa_algorithm_t)0)

An invalid algorithm identifier value.

#define
PSA_ALG_HASH_MASK ((psa_algorithm_t) 0x000000ff)
#define
PSA_ALG_MD5 ((psa_algorithm_t) 0x02000003)

MD5.

#define
PSA_ALG_RIPEMD160 ((psa_algorithm_t) 0x02000004)

PSA_ALG_RIPEMD160.

#define
PSA_ALG_SHA_1 ((psa_algorithm_t) 0x02000005)

SHA1.

#define
PSA_ALG_SHA_224 ((psa_algorithm_t) 0x02000008)

SHA2-224.

#define
PSA_ALG_SHA_256 ((psa_algorithm_t) 0x02000009)

SHA2-256.

#define
PSA_ALG_SHA_384 ((psa_algorithm_t) 0x0200000a)

SHA2-384.

#define
PSA_ALG_SHA_512 ((psa_algorithm_t) 0x0200000b)

SHA2-512.

#define
PSA_ALG_SHA_512_224 ((psa_algorithm_t) 0x0200000c)

SHA2-512/224.

#define
PSA_ALG_SHA_512_256 ((psa_algorithm_t) 0x0200000d)

SHA2-512/256.

#define
PSA_ALG_SHA3_224 ((psa_algorithm_t) 0x02000010)

SHA3-224.

#define
PSA_ALG_SHA3_256 ((psa_algorithm_t) 0x02000011)

SHA3-256.

#define
PSA_ALG_SHA3_384 ((psa_algorithm_t) 0x02000012)

SHA3-384.

#define
PSA_ALG_SHA3_512 ((psa_algorithm_t) 0x02000013)

SHA3-512.

#define
PSA_ALG_SHAKE256_512 ((psa_algorithm_t) 0x02000015)

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

#define
PSA_ALG_ANY_HASH ((psa_algorithm_t) 0x020000ff)

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

#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)

Macro to build an HMAC algorithm.

#define
#define

Whether the specified algorithm is an HMAC algorithm.

#define
PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t) 0x003f0000)
#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.

#define

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

#define

Length to which a MAC algorithm is truncated.

#define
PSA_ALG_AT_LEAST_THIS_LENGTH_MAC (mac_alg, min_mac_length)

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

#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.

#define
PSA_ALG_CMAC ((psa_algorithm_t) 0x03c00200)

The CMAC construction over a block cipher.

#define

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

#define
PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t) 0x00800000)
#define
PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
#define

Whether the specified algorithm is a stream cipher.

#define
PSA_ALG_STREAM_CIPHER ((psa_algorithm_t) 0x04800100)

The stream cipher mode of a stream cipher algorithm.

#define
PSA_ALG_CTR ((psa_algorithm_t) 0x04c01000)

The CTR stream cipher mode.

#define
PSA_ALG_CFB ((psa_algorithm_t) 0x04c01100)

The CFB stream cipher mode.

#define
PSA_ALG_OFB ((psa_algorithm_t) 0x04c01200)

The OFB stream cipher mode.

#define
PSA_ALG_XTS ((psa_algorithm_t) 0x0440ff00)

The XTS cipher mode.

#define
PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t) 0x04404400)

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

#define
PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t) 0x04404000)

The CBC block cipher chaining mode, with no padding.

#define
PSA_ALG_CBC_PKCS7 ((psa_algorithm_t) 0x04404100)

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

#define
PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
#define

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

#define
PSA_ALG_CCM ((psa_algorithm_t) 0x05500100)

The CCM authenticated encryption algorithm.

#define
PSA_ALG_CCM_STAR_NO_TAG ((psa_algorithm_t) 0x04c01300)

The CCM* cipher mode without authentication.

#define
PSA_ALG_GCM ((psa_algorithm_t) 0x05500200)

The GCM authenticated encryption algorithm.

#define
PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t) 0x05100500)

The Chacha20-Poly1305 AEAD algorithm.

#define
PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t) 0x003f0000)
#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.

#define

Retrieve the tag length of a specified AEAD algorithm.

#define

Calculate the corresponding AEAD algorithm with the default tag length.

#define

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

#define
PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t) 0x06000200)
#define

RSA PKCS#1 v1.5 signature with hashing.

#define
PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE

Raw PKCS#1 v1.5 signature.

#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)

RSA PSS signature with hashing.

#define

RSA PSS signature with hashing with relaxed verification.

#define

Whether the specified algorithm is RSA PSS with standard salt.

#define

Whether the specified algorithm is RSA PSS with any salt.

#define

Whether the specified algorithm is RSA PSS.

#define
PSA_ALG_ECDSA_BASE ((psa_algorithm_t) 0x06000600)
#define
PSA_ALG_ECDSA (hash_alg)

ECDSA signature with hashing.

#define
PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE

ECDSA signature without hashing.

#define
PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t) 0x06000700)
#define

Deterministic ECDSA signature with hashing.

#define
PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t) 0x00000100)
#define
#define
PSA_ALG_PURE_EDDSA ((psa_algorithm_t) 0x06000800)

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

#define
PSA_ALG_HASH_EDDSA_BASE ((psa_algorithm_t) 0x06000900)
#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.

#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.

#define

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

#define

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

#define

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

#define

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

#define
PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t) 0x07000200)

RSA PKCS#1 v1.5 encryption.

#define
PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t) 0x07000300)
#define
PSA_ALG_RSA_OAEP (hash_alg)

RSA OAEP encryption.

#define
#define
PSA_ALG_HKDF_BASE ((psa_algorithm_t) 0x08000100)
#define
PSA_ALG_HKDF (hash_alg)

Macro to build an HKDF algorithm.

#define

Whether the specified algorithm is an HKDF algorithm.

#define
#define
PSA_ALG_HKDF_EXTRACT_BASE ((psa_algorithm_t) 0x08000400)
#define

Macro to build an HKDF-Extract algorithm.

#define

Whether the specified algorithm is an HKDF-Extract algorithm.

#define
PSA_ALG_HKDF_EXPAND_BASE ((psa_algorithm_t) 0x08000500)
#define

Macro to build an HKDF-Expand algorithm.

#define

Whether the specified algorithm is an HKDF-Expand algorithm.

#define

Whether the specified algorithm is an HKDF or HKDF-Extract or HKDF-Expand algorithm.

#define
PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t) 0x08000200)
#define

Macro to build a TLS-1.2 PRF algorithm.

#define

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

#define
#define
PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t) 0x08000300)
#define

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

#define

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

#define
PSA_ALG_TLS12_ECJPAKE_TO_PMS ((psa_algorithm_t) 0x08000609)
#define
PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG ((psa_algorithm_t) 0x00800000)
#define
PSA_ALG_PBKDF2_HMAC_BASE ((psa_algorithm_t) 0x08800100)
#define

Macro to build a PBKDF2-HMAC password hashing / key stretching algorithm.

#define

Whether the specified algorithm is a PBKDF2-HMAC algorithm.

#define
#define
PSA_ALG_PBKDF2_AES_CMAC_PRF_128 ((psa_algorithm_t) 0x08800200)

The PBKDF2-AES-CMAC-PRF-128 password hashing / key stretching algorithm.

#define
#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)

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

#define

Whether the specified algorithm is a raw key agreement algorithm.

#define
PSA_ALG_FFDH ((psa_algorithm_t) 0x09010000)

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

#define

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

#define
PSA_ALG_ECDH ((psa_algorithm_t) 0x09020000)

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

#define

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

#define

Whether the specified algorithm encoding is a wildcard.

#define

Get the hash used by a composite algorithm.

#define
PSA_KEY_TYPE_DSA_PUBLIC_KEY ((psa_key_type_t) 0x4002)

DSA public key.

#define
PSA_KEY_TYPE_DSA_KEY_PAIR ((psa_key_type_t) 0x7002)

DSA key pair (private and public key).

#define

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

#define
PSA_ALG_DSA_BASE ((psa_algorithm_t) 0x06000400)
#define
PSA_ALG_DSA (hash_alg)

DSA signature with hashing.

#define
PSA_ALG_DETERMINISTIC_DSA_BASE ((psa_algorithm_t) 0x06000500)
#define
PSA_ALG_DSA_DETERMINISTIC_FLAG PSA_ALG_ECDSA_DETERMINISTIC_FLAG
#define

Deterministic DSA signature with hashing.

#define
#define
PSA_ALG_CATEGORY_PAKE ((psa_algorithm_t) 0x0a000000)
#define

Whether the specified algorithm is a password-authenticated key exchange.

#define
PSA_ALG_JPAKE ((psa_algorithm_t) 0x0a000100)

The Password-authenticated key exchange by juggling (J-PAKE) algorithm.

Typedef Documentation#

psa_key_type_t#

typedef uint16_t 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 75 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_types.h

psa_ecc_family_t#

typedef uint8_t 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 94 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_types.h

psa_dh_family_t#

typedef uint8_t 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 113 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_types.h

psa_algorithm_t#

typedef uint32_t 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 131 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_types.h

psa_key_type_t#

typedef uint16_t 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 90 of file util/third_party/mbedtls/include/psa/crypto_types.h

psa_ecc_family_t#

typedef uint8_t 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 109 of file util/third_party/mbedtls/include/psa/crypto_types.h

psa_dh_family_t#

typedef uint8_t 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 128 of file util/third_party/mbedtls/include/psa/crypto_types.h

psa_algorithm_t#

typedef uint32_t 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 146 of file util/third_party/mbedtls/include/psa/crypto_types.h

Macro Definition Documentation#

PSA_KEY_TYPE_DSA_PUBLIC_KEY#

#define PSA_KEY_TYPE_DSA_PUBLIC_KEY
Value:
((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 147 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_KEY_TYPE_DSA_KEY_PAIR#

#define PSA_KEY_TYPE_DSA_KEY_PAIR
Value:
((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).

Determinstic 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 165 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_KEY_TYPE_IS_DSA#

#define PSA_KEY_TYPE_IS_DSA
Value:
(type)

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


Definition at line 168 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DSA_BASE#

#define PSA_ALG_DSA_BASE
Value:
((psa_algorithm_t)0x06000400)

Definition at line 171 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DSA#

#define PSA_ALG_DSA
Value:
(hash_alg)

DSA signature with hashing.

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

Returns

  • The corresponding DSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 186 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DETERMINISTIC_DSA_BASE#

#define PSA_ALG_DETERMINISTIC_DSA_BASE
Value:
((psa_algorithm_t)0x06000500)

Definition at line 188 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DSA_DETERMINISTIC_FLAG#

#define PSA_ALG_DSA_DETERMINISTIC_FLAG
Value:
PSA_ALG_ECDSA_DETERMINISTIC_FLAG

Definition at line 189 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DETERMINISTIC_DSA#

#define PSA_ALG_DETERMINISTIC_DSA
Value:
(hash_alg)

Deterministic DSA signature with hashing.

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

Returns

  • The corresponding DSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 204 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_IS_DSA#

#define PSA_ALG_IS_DSA
Value:
(((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_DSA_DETERMINISTIC_FLAG) == \
PSA_ALG_DSA_BASE)

Definition at line 206 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_DSA_IS_DETERMINISTIC#

#define PSA_ALG_DSA_IS_DETERMINISTIC
Value:
(alg)

Definition at line 209 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_IS_DETERMINISTIC_DSA#

#define PSA_ALG_IS_DETERMINISTIC_DSA
Value:
(alg)

Definition at line 211 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_IS_RANDOMIZED_DSA#

#define PSA_ALG_IS_RANDOMIZED_DSA
Value:
(alg)

Definition at line 213 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_IS_VENDOR_HASH_AND_SIGN#

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN
Value:
(alg)

Definition at line 220 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_CATEGORY_PAKE#

#define PSA_ALG_CATEGORY_PAKE
Value:
((psa_algorithm_t) 0x0a000000)

Definition at line 453 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_IS_PAKE#

#define PSA_ALG_IS_PAKE
Value:
(alg)

Whether the specified algorithm is a password-authenticated key exchange.

Returns

  • 1 if alg is a password-authenticated key exchange (PAKE) algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.


Definition at line 464 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_ALG_JPAKE#

#define PSA_ALG_JPAKE
Value:
((psa_algorithm_t) 0x0a000100)

The Password-authenticated key exchange by juggling (J-PAKE) algorithm.

This is J-PAKE as defined by RFC 8236, instantiated with the following parameters:

  • The group can be either an elliptic curve or defined over a finite field.

  • Schnorr NIZK proof as defined by RFC 8235 and using the same group as the J-PAKE algorithm.

  • A cryptographic hash function.

To select these parameters and set up the cipher suite, call these functions in any order:

psa_pake_cs_set_algorithm(cipher_suite, PSA_ALG_JPAKE);
psa_pake_cs_set_primitive(cipher_suite,
                          PSA_PAKE_PRIMITIVE(type, family, bits));
psa_pake_cs_set_hash(cipher_suite, hash);

For more information on how to set a specific curve or field, refer to the documentation of the individual PSA_PAKE_PRIMITIVE_TYPE_XXX constants.

After initializing a J-PAKE operation, call

psa_pake_setup(operation, cipher_suite);
psa_pake_set_user(operation, ...);
psa_pake_set_peer(operation, ...);
psa_pake_set_password_key(operation, ...);

The password is provided as a key. This can be the password text itself, in an agreed character encoding, or some value derived from the password as required by a higher level protocol.

(The implementation converts the key material to a number as described in Section 2.3.8 of SEC 1: Elliptic Curve Cryptography (https://www.secg.org/sec1-v2.pdf), before reducing it modulo q. Here q is order of the group defined by the primitive set in the cipher suite. The psa_pake_set_password_key() function returns an error if the result of the reduction is 0.)

The key exchange flow for J-PAKE is as follows:

  1. To get the first round data that needs to be sent to the peer, call

    // Get g1
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get the ZKP public key for x1
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get the ZKP proof for x1
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    // Get g2
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get the ZKP public key for x2
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get the ZKP proof for x2
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  2. To provide the first round data received from the peer to the operation, call

    // Set g3
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set the ZKP public key for x3
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set the ZKP proof for x3
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    // Set g4
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set the ZKP public key for x4
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set the ZKP proof for x4
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  3. To get the second round data that needs to be sent to the peer, call

    // Get A
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get ZKP public key for x2*s
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get ZKP proof for x2*s
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  4. To provide the second round data received from the peer to the operation, call

    // Set B
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set ZKP public key for x4*s
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set ZKP proof for x4*s
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  5. To access the shared secret call

    // Get Ka=Kb=K
    psa_pake_get_implicit_key()
    

For more information consult the documentation of the individual PSA_PAKE_STEP_XXX constants.

At this point there is a cryptographic guarantee that only the authenticated party who used the same password is able to compute the key. But there is no guarantee that the peer is the party it claims to be and was able to do so.

That is, the authentication is only implicit (the peer is not authenticated at this point, and no action should be taken that assume that they are - like for example accessing restricted files).

To make the authentication explicit there are various methods, see Section 5 of RFC 8236 for two examples.


Definition at line 582 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_extra.h

PSA_KEY_TYPE_NONE#

#define PSA_KEY_TYPE_NONE
Value:
((psa_key_type_t) 0x0000)

An invalid key type value.

Zero is not the encoding of any key type.


Definition at line 359 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_VENDOR_FLAG#

#define PSA_KEY_TYPE_VENDOR_FLAG
Value:
((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 368 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_MASK#

#define PSA_KEY_TYPE_CATEGORY_MASK
Value:
((psa_key_type_t) 0x7000)

Definition at line 370 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_RAW#

#define PSA_KEY_TYPE_CATEGORY_RAW
Value:
((psa_key_type_t) 0x1000)

Definition at line 371 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_SYMMETRIC#

#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC
Value:
((psa_key_type_t) 0x2000)

Definition at line 372 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY#

#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY
Value:
((psa_key_type_t) 0x4000)

Definition at line 373 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_KEY_PAIR#

#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR
Value:
((psa_key_type_t) 0x7000)

Definition at line 374 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_FLAG_PAIR#

#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR
Value:
((psa_key_type_t) 0x3000)

Definition at line 376 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_VENDOR_DEFINED#

#define PSA_KEY_TYPE_IS_VENDOR_DEFINED
Value:
(type)

Whether a key type is vendor-defined.

See also PSA_KEY_TYPE_VENDOR_FLAG.


Definition at line 382 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_UNSTRUCTURED#

#define PSA_KEY_TYPE_IS_UNSTRUCTURED
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)

Whether a key type is an unstructured array of bytes.

This encompasses both symmetric keys and non-key data.


Definition at line 389 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ASYMMETRIC#

#define PSA_KEY_TYPE_IS_ASYMMETRIC
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK \
& ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)

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


Definition at line 394 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_PUBLIC_KEY
Value:
(type)

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


Definition at line 399 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_KEY_PAIR#

#define PSA_KEY_TYPE_IS_KEY_PAIR
Value:
(type)

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


Definition at line 403 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY#

#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY
Value:
(type)

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.

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 415 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR#

#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR
Value:
(type)

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.

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 427 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_RAW_DATA#

#define PSA_KEY_TYPE_RAW_DATA
Value:
((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 434 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_HMAC#

#define PSA_KEY_TYPE_HMAC
Value:
((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 444 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DERIVE#

#define PSA_KEY_TYPE_DERIVE
Value:
((psa_key_type_t) 0x1200)

A secret for key derivation.

This key type is for high-entropy secrets only. For low-entropy secrets, PSA_KEY_TYPE_PASSWORD should be used instead.

These keys can be used as the PSA_KEY_DERIVATION_INPUT_SECRET or PSA_KEY_DERIVATION_INPUT_PASSWORD input of key derivation algorithms.

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


Definition at line 457 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_PASSWORD#

#define PSA_KEY_TYPE_PASSWORD
Value:
((psa_key_type_t) 0x1203)

A low-entropy secret for password hashing or key derivation.

This key type is suitable for passwords and passphrases which are typically intended to be memorizable by humans, and have a low entropy relative to their size. It can be used for randomly generated or derived keys with maximum or near-maximum entropy, but PSA_KEY_TYPE_DERIVE is more suitable for such keys. It is not suitable for passwords with extremely low entropy, such as numerical PINs.

These keys can be used as the PSA_KEY_DERIVATION_INPUT_PASSWORD input of key derivation algorithms. Algorithms that accept such an input were designed to accept low-entropy secret and are known as password hashing or key stretching algorithms.

These keys cannot be used as the PSA_KEY_DERIVATION_INPUT_SECRET input of key derivation algorithms, as the algorithms that take such an input expect it to be high-entropy.

The key policy determines which key derivation algorithm the key can be used for, among the permissible subset defined above.


Definition at line 480 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_PASSWORD_HASH#

#define PSA_KEY_TYPE_PASSWORD_HASH
Value:
((psa_key_type_t) 0x1205)

A secret value that can be used to verify a password hash.

The key policy determines which key derivation algorithm the key can be used for, among the same permissible subset as for PSA_KEY_TYPE_PASSWORD.


Definition at line 488 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_PEPPER#

#define PSA_KEY_TYPE_PEPPER
Value:
((psa_key_type_t) 0x1206)

A secret value that can be used in when computing a password hash.

The key policy determines which key derivation algorithm the key can be used for, among the subset of algorithms that can use pepper.


Definition at line 495 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_AES#

#define PSA_KEY_TYPE_AES
Value:
((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 502 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ARIA#

#define PSA_KEY_TYPE_ARIA
Value:
((psa_key_type_t) 0x2406)

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


Definition at line 506 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DES#

#define PSA_KEY_TYPE_DES
Value:
((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 517 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CAMELLIA#

#define PSA_KEY_TYPE_CAMELLIA
Value:
((psa_key_type_t) 0x2403)

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


Definition at line 521 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_CHACHA20#

#define PSA_KEY_TYPE_CHACHA20
Value:
((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.

Note

  • For ChaCha20 and ChaCha20_Poly1305, Mbed TLS only supports 12-byte nonces.

  • For ChaCha20, the initial counter value is 0. To encrypt or decrypt with the initial counter value 1, you can process and discard a 64-byte block before the real data.


Definition at line 534 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_RSA_PUBLIC_KEY#

#define PSA_KEY_TYPE_RSA_PUBLIC_KEY
Value:
((psa_key_type_t) 0x4001)

RSA public key.

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


Definition at line 540 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_RSA_KEY_PAIR#

#define PSA_KEY_TYPE_RSA_KEY_PAIR
Value:
((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 545 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_RSA#

#define PSA_KEY_TYPE_IS_RSA
Value:
(type)

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


Definition at line 547 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE#

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE
Value:
((psa_key_type_t) 0x4100)

Definition at line 550 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_KEY_PAIR_BASE#

#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE
Value:
((psa_key_type_t) 0x7100)

Definition at line 551 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_CURVE_MASK#

#define PSA_KEY_TYPE_ECC_CURVE_MASK
Value:
((psa_key_type_t) 0x00ff)

Definition at line 552 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_KEY_PAIR#

#define PSA_KEY_TYPE_ECC_KEY_PAIR
Value:
(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.


Definition at line 562 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_PUBLIC_KEY#

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY
Value:
(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).


Definition at line 573 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC#

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

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


Definition at line 577 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC_KEY_PAIR#

#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR
Value:
(((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)

Whether a key type is an elliptic curve key pair.


Definition at line 581 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY
Value:
(((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)

Whether a key type is an elliptic curve public key.


Definition at line 585 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_GET_FAMILY#

#define PSA_KEY_TYPE_ECC_GET_FAMILY
Value:
((psa_ecc_family_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
0))

Extract the curve from an elliptic curve key type.


Definition at line 590 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_IS_WEIERSTRASS#

#define PSA_ECC_FAMILY_IS_WEIERSTRASS
Value:
(family)

Check if the curve of given family is Weierstrass elliptic curve.


Definition at line 596 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_K1#

#define PSA_ECC_FAMILY_SECP_K1
Value:
((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 606 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_R1#

#define PSA_ECC_FAMILY_SECP_R1
Value:
((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 616 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_R2#

#define PSA_ECC_FAMILY_SECP_R2
Value:
((psa_ecc_family_t) 0x1b)

Definition at line 618 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_K1#

#define PSA_ECC_FAMILY_SECT_K1
Value:
((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 628 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_R1#

#define PSA_ECC_FAMILY_SECT_R1
Value:
((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 638 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_R2#

#define PSA_ECC_FAMILY_SECT_R2
Value:
((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 648 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_BRAINPOOL_P_R1#

#define PSA_ECC_FAMILY_BRAINPOOL_P_R1
Value:
((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 657 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_MONTGOMERY#

#define PSA_ECC_FAMILY_MONTGOMERY
Value:
((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 669 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ECC_FAMILY_TWISTED_EDWARDS#

#define PSA_ECC_FAMILY_TWISTED_EDWARDS
Value:
((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 685 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE#

#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE
Value:
((psa_key_type_t) 0x4200)

Definition at line 687 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_KEY_PAIR_BASE#

#define PSA_KEY_TYPE_DH_KEY_PAIR_BASE
Value:
((psa_key_type_t) 0x7200)

Definition at line 688 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_GROUP_MASK#

#define PSA_KEY_TYPE_DH_GROUP_MASK
Value:
((psa_key_type_t) 0x00ff)

Definition at line 689 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_KEY_PAIR#

#define PSA_KEY_TYPE_DH_KEY_PAIR
Value:
(group)

Diffie-Hellman key pair.


Definition at line 695 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_PUBLIC_KEY#

#define PSA_KEY_TYPE_DH_PUBLIC_KEY
Value:
(group)

Diffie-Hellman public key.


Definition at line 702 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH#

#define PSA_KEY_TYPE_IS_DH
Value:
((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)

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


Definition at line 706 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH_KEY_PAIR#

#define PSA_KEY_TYPE_IS_DH_KEY_PAIR
Value:
(((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
PSA_KEY_TYPE_DH_KEY_PAIR_BASE)

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


Definition at line 710 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY
Value:
(((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)

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


Definition at line 714 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_GET_FAMILY#

#define PSA_KEY_TYPE_DH_GET_FAMILY
Value:
((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
0))

Extract the group from a Diffie-Hellman key type.


Definition at line 719 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_DH_FAMILY_RFC7919#

#define PSA_DH_FAMILY_RFC7919
Value:
((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 730 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT#

#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT
Value:
(type)

Definition at line 732 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_BLOCK_CIPHER_BLOCK_LENGTH#

#define PSA_BLOCK_CIPHER_BLOCK_LENGTH
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
0u)

The block size of a block cipher.

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.

Warnings

  • This macro may evaluate its argument multiple times.


Definition at line 752 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_VENDOR_FLAG#

#define PSA_ALG_VENDOR_FLAG
Value:
((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 769 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_MASK#

#define PSA_ALG_CATEGORY_MASK
Value:
((psa_algorithm_t) 0x7f000000)

Definition at line 771 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_HASH#

#define PSA_ALG_CATEGORY_HASH
Value:
((psa_algorithm_t) 0x02000000)

Definition at line 772 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_MAC#

#define PSA_ALG_CATEGORY_MAC
Value:
((psa_algorithm_t) 0x03000000)

Definition at line 773 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_CIPHER#

#define PSA_ALG_CATEGORY_CIPHER
Value:
((psa_algorithm_t) 0x04000000)

Definition at line 774 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_AEAD#

#define PSA_ALG_CATEGORY_AEAD
Value:
((psa_algorithm_t) 0x05000000)

Definition at line 775 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_SIGN#

#define PSA_ALG_CATEGORY_SIGN
Value:
((psa_algorithm_t) 0x06000000)

Definition at line 776 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION#

#define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION
Value:
((psa_algorithm_t) 0x07000000)

Definition at line 777 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_KEY_DERIVATION#

#define PSA_ALG_CATEGORY_KEY_DERIVATION
Value:
((psa_algorithm_t) 0x08000000)

Definition at line 778 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CATEGORY_KEY_AGREEMENT#

#define PSA_ALG_CATEGORY_KEY_AGREEMENT
Value:
((psa_algorithm_t) 0x09000000)

Definition at line 779 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_VENDOR_DEFINED#

#define PSA_ALG_IS_VENDOR_DEFINED
Value:
(alg)

Whether an algorithm is vendor-defined.

See also PSA_ALG_VENDOR_FLAG.


Definition at line 785 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HASH#

#define PSA_ALG_IS_HASH
Value:
(alg)

Whether the specified algorithm is a hash algorithm.

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 796 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_MAC#

#define PSA_ALG_IS_MAC
Value:
(alg)

Whether the specified algorithm is a MAC algorithm.

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 807 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_CIPHER#

#define PSA_ALG_IS_CIPHER
Value:
(alg)

Whether the specified algorithm is a symmetric cipher algorithm.

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 818 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_AEAD#

#define PSA_ALG_IS_AEAD
Value:
(alg)

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

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 830 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_SIGN#

#define PSA_ALG_IS_SIGN
Value:
(alg)

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

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 842 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_ASYMMETRIC_ENCRYPTION#

#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION
Value:
(alg)

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

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 854 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_KEY_AGREEMENT#

#define PSA_ALG_IS_KEY_AGREEMENT
Value:
(alg)

Whether the specified algorithm is a key agreement algorithm.

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 865 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION#

#define PSA_ALG_IS_KEY_DERIVATION
Value:
(alg)

Whether the specified algorithm is a key derivation algorithm.

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 876 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION_STRETCHING#

#define PSA_ALG_IS_KEY_DERIVATION_STRETCHING
Value:
(PSA_ALG_IS_KEY_DERIVATION(alg) && \
(alg) & PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG)

Whether the specified algorithm is a key stretching / password hashing algorithm.

A key stretching / password hashing algorithm is a key derivation algorithm that is suitable for use with a low-entropy secret such as a password. Equivalently, it's a key derivation algorithm that uses a PSA_KEY_DERIVATION_INPUT_PASSWORD input step.

Returns

  • 1 if alg is a key stretching / password hashing algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.


Definition at line 893 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_NONE#

#define PSA_ALG_NONE
Value:
((psa_algorithm_t)0)

An invalid algorithm identifier value.


Definition at line 899 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HASH_MASK#

#define PSA_ALG_HASH_MASK
Value:
((psa_algorithm_t) 0x000000ff)

Definition at line 902 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_MD5#

#define PSA_ALG_MD5
Value:
((psa_algorithm_t) 0x02000003)

MD5.


Definition at line 904 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RIPEMD160#

#define PSA_ALG_RIPEMD160
Value:
((psa_algorithm_t) 0x02000004)

PSA_ALG_RIPEMD160.


Definition at line 906 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_1#

#define PSA_ALG_SHA_1
Value:
((psa_algorithm_t) 0x02000005)

SHA1.


Definition at line 908 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_224#

#define PSA_ALG_SHA_224
Value:
((psa_algorithm_t) 0x02000008)

SHA2-224.


Definition at line 910 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_256#

#define PSA_ALG_SHA_256
Value:
((psa_algorithm_t) 0x02000009)

SHA2-256.


Definition at line 912 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_384#

#define PSA_ALG_SHA_384
Value:
((psa_algorithm_t) 0x0200000a)

SHA2-384.


Definition at line 914 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_512#

#define PSA_ALG_SHA_512
Value:
((psa_algorithm_t) 0x0200000b)

SHA2-512.


Definition at line 916 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_512_224#

#define PSA_ALG_SHA_512_224
Value:
((psa_algorithm_t) 0x0200000c)

SHA2-512/224.


Definition at line 918 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA_512_256#

#define PSA_ALG_SHA_512_256
Value:
((psa_algorithm_t) 0x0200000d)

SHA2-512/256.


Definition at line 920 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA3_224#

#define PSA_ALG_SHA3_224
Value:
((psa_algorithm_t) 0x02000010)

SHA3-224.


Definition at line 922 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA3_256#

#define PSA_ALG_SHA3_256
Value:
((psa_algorithm_t) 0x02000011)

SHA3-256.


Definition at line 924 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA3_384#

#define PSA_ALG_SHA3_384
Value:
((psa_algorithm_t) 0x02000012)

SHA3-384.


Definition at line 926 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHA3_512#

#define PSA_ALG_SHA3_512
Value:
((psa_algorithm_t) 0x02000013)

SHA3-512.


Definition at line 928 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SHAKE256_512#

#define PSA_ALG_SHAKE256_512
Value:
((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 935 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ANY_HASH#

#define PSA_ALG_ANY_HASH
Value:
((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:

  • PSA_ALG_RSA_PKCS1V15_SIGN, PSA_ALG_RSA_PSS, PSA_ALG_RSA_PSS_ANY_SALT,

  • PSA_ALG_ECDSA, PSA_ALG_DETERMINISTIC_ECDSA. Then you may create and use a key as follows:

  • Set the key usage field using PSA_ALG_ANY_HASH, for example:

    psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH); // or VERIFY
    psa_set_key_algorithm(&attributes, PSA_xxx_SIGNATURE(PSA_ALG_ANY_HASH));
    
  • Import or generate key material.

  • Call psa_sign_hash() or psa_verify_hash(), passing an algorithm built from PSA_xxx_SIGNATURE and a specific hash. Each call to sign or verify a message may use a different hash.

    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA_256), ...);
    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA_512), ...);
    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA3_256), ...);
    

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 970 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_MAC_SUBCATEGORY_MASK#

#define PSA_ALG_MAC_SUBCATEGORY_MASK
Value:
((psa_algorithm_t) 0x00c00000)

Definition at line 972 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HMAC_BASE#

#define PSA_ALG_HMAC_BASE
Value:
((psa_algorithm_t) 0x03800000)

Definition at line 973 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HMAC#

#define PSA_ALG_HMAC
Value:
(hash_alg)

Macro to build an HMAC algorithm.

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

Returns

  • The corresponding HMAC algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 985 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HMAC_GET_HASH#

#define PSA_ALG_HMAC_GET_HASH
Value:
(hmac_alg)

Definition at line 988 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HMAC#

#define PSA_ALG_IS_HMAC
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
PSA_ALG_HMAC_BASE)

Whether the specified algorithm is an HMAC algorithm.

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

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 1001 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_MAC_TRUNCATION_MASK#

#define PSA_ALG_MAC_TRUNCATION_MASK
Value:
((psa_algorithm_t) 0x003f0000)

Definition at line 1012 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_MAC_TRUNCATION_OFFSET#

#define PSA_MAC_TRUNCATION_OFFSET
Value:
16

Definition at line 1013 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG#

#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG
Value:
((psa_algorithm_t) 0x00008000)

Definition at line 1021 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TRUNCATED_MAC#

#define PSA_ALG_TRUNCATED_MAC
Value:
(((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)) | \
((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))

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.

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 1056 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_FULL_LENGTH_MAC#

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

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

Returns

  • The corresponding base MAC algorithm.

  • Unspecified if mac_alg is not a supported MAC algorithm.


Definition at line 1073 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_MAC_TRUNCATED_LENGTH#

#define PSA_MAC_TRUNCATED_LENGTH
Value:
(mac_alg)

Length to which a MAC algorithm is truncated.

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 1088 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AT_LEAST_THIS_LENGTH_MAC#

#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC
Value:
(PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)

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.

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 1115 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CIPHER_MAC_BASE#

#define PSA_ALG_CIPHER_MAC_BASE
Value:
((psa_algorithm_t) 0x03c00000)

Definition at line 1119 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CBC_MAC#

#define PSA_ALG_CBC_MAC
Value:
((psa_algorithm_t) 0x03c00100)

The CBC-MAC construction over a block cipher.

Warnings

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


Definition at line 1125 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CMAC#

#define PSA_ALG_CMAC
Value:
((psa_algorithm_t) 0x03c00200)

The CMAC construction over a block cipher.


Definition at line 1127 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_BLOCK_CIPHER_MAC#

#define PSA_ALG_IS_BLOCK_CIPHER_MAC
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
PSA_ALG_CIPHER_MAC_BASE)

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

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 1137 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CIPHER_STREAM_FLAG#

#define PSA_ALG_CIPHER_STREAM_FLAG
Value:
((psa_algorithm_t) 0x00800000)

Definition at line 1141 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CIPHER_FROM_BLOCK_FLAG#

#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG
Value:
((psa_algorithm_t) 0x00400000)

Definition at line 1142 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_STREAM_CIPHER#

#define PSA_ALG_IS_STREAM_CIPHER
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
(PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))

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.

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 1156 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_STREAM_CIPHER#

#define PSA_ALG_STREAM_CIPHER
Value:
((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 1165 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CTR#

#define PSA_ALG_CTR
Value:
((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 1174 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CFB#

#define PSA_ALG_CFB
Value:
((psa_algorithm_t) 0x04c01100)

The CFB stream cipher mode.

The underlying block cipher is determined by the key type.


Definition at line 1180 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_OFB#

#define PSA_ALG_OFB
Value:
((psa_algorithm_t) 0x04c01200)

The OFB stream cipher mode.

The underlying block cipher is determined by the key type.


Definition at line 1186 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_XTS#

#define PSA_ALG_XTS
Value:
((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 1194 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECB_NO_PADDING#

#define PSA_ALG_ECB_NO_PADDING
Value:
((psa_algorithm_t) 0x04404400)

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

Warnings

  • 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 1214 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CBC_NO_PADDING#

#define PSA_ALG_CBC_NO_PADDING
Value:
((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 1223 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CBC_PKCS7#

#define PSA_ALG_CBC_PKCS7
Value:
((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 1231 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_FROM_BLOCK_FLAG#

#define PSA_ALG_AEAD_FROM_BLOCK_FLAG
Value:
((psa_algorithm_t) 0x00400000)

Definition at line 1233 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER#

#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
(PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))

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

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 1244 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CCM#

#define PSA_ALG_CCM
Value:
((psa_algorithm_t) 0x05500100)

The CCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.


Definition at line 1252 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CCM_STAR_NO_TAG#

#define PSA_ALG_CCM_STAR_NO_TAG
Value:
((psa_algorithm_t) 0x04c01300)

The CCM* cipher mode without authentication.

This is CCM* as specified in IEEE 802.15.4 §7, with a tag length of 0. For CCM* with a nonzero tag length, use the AEAD algorithm PSA_ALG_CCM.

The underlying block cipher is determined by the key type.

Currently only 13-byte long IV's are supported.


Definition at line 1263 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_GCM#

#define PSA_ALG_GCM
Value:
((psa_algorithm_t) 0x05500200)

The GCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.


Definition at line 1269 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_CHACHA20_POLY1305#

#define PSA_ALG_CHACHA20_POLY1305
Value:
((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 1280 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_TAG_LENGTH_MASK#

#define PSA_ALG_AEAD_TAG_LENGTH_MASK
Value:
((psa_algorithm_t) 0x003f0000)

Definition at line 1286 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_AEAD_TAG_LENGTH_OFFSET#

#define PSA_AEAD_TAG_LENGTH_OFFSET
Value:
16

Definition at line 1287 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG#

#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG
Value:
((psa_algorithm_t) 0x00008000)

Definition at line 1295 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_SHORTENED_TAG#

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

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.

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 1315 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_GET_TAG_LENGTH#

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

Retrieve the tag length of a specified AEAD algorithm.

Returns

  • The tag length specified by the input algorithm.

  • Unspecified if aead_alg is not a supported AEAD algorithm.


Definition at line 1331 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG#

#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG
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)

Calculate the corresponding AEAD algorithm with the default tag length.

Returns

  • The corresponding AEAD algorithm with the default tag length for that algorithm.


Definition at line 1343 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE#

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

Definition at line 1349 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG#

#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG
Value:
(PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)

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.

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 1378 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN_BASE#

#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE
Value:
((psa_algorithm_t) 0x06000200)

Definition at line 1382 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN#

#define PSA_ALG_RSA_PKCS1V15_SIGN
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PKCS#1 v1.5 signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1398 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN_RAW#

#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW
Value:
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 1406 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PKCS1V15_SIGN#

#define PSA_ALG_IS_RSA_PKCS1V15_SIGN
Value:
(alg)

Definition at line 1407 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_BASE#

#define PSA_ALG_RSA_PSS_BASE
Value:
((psa_algorithm_t) 0x06000300)

Definition at line 1410 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_ANY_SALT_BASE#

#define PSA_ALG_RSA_PSS_ANY_SALT_BASE
Value:
((psa_algorithm_t) 0x06001300)

Definition at line 1411 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PSS#

#define PSA_ALG_RSA_PSS
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PSS signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1432 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_ANY_SALT#

#define PSA_ALG_RSA_PSS_ANY_SALT
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PSS signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1450 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS_STANDARD_SALT#

#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT
Value:
(alg)

Whether the specified algorithm is RSA PSS with standard salt.

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 1464 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS_ANY_SALT#

#define PSA_ALG_IS_RSA_PSS_ANY_SALT
Value:
(alg)

Whether the specified algorithm is RSA PSS with any salt.

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 1478 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS#

#define PSA_ALG_IS_RSA_PSS
Value:
(PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) || \
PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))

Whether the specified algorithm is RSA PSS.

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

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 1496 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDSA_BASE#

#define PSA_ALG_ECDSA_BASE
Value:
((psa_algorithm_t) 0x06000600)

Definition at line 1500 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDSA#

#define PSA_ALG_ECDSA
Value:
(hash_alg)

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).

Returns

  • The corresponding ECDSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1521 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDSA_ANY#

#define PSA_ALG_ECDSA_ANY
Value:
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 1532 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_DETERMINISTIC_ECDSA_BASE#

#define PSA_ALG_DETERMINISTIC_ECDSA_BASE
Value:
((psa_algorithm_t) 0x06000700)

Definition at line 1533 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_DETERMINISTIC_ECDSA#

#define PSA_ALG_DETERMINISTIC_ECDSA
Value:
(hash_alg)

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.

Returns

  • The corresponding deterministic ECDSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1556 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDSA_DETERMINISTIC_FLAG#

#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG
Value:
((psa_algorithm_t) 0x00000100)

Definition at line 1558 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_ECDSA#

#define PSA_ALG_IS_ECDSA
Value:
(((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
PSA_ALG_ECDSA_BASE)

Definition at line 1559 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDSA_IS_DETERMINISTIC#

#define PSA_ALG_ECDSA_IS_DETERMINISTIC
Value:
(alg)

Definition at line 1562 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_DETERMINISTIC_ECDSA#

#define PSA_ALG_IS_DETERMINISTIC_ECDSA
Value:
(alg)

Definition at line 1564 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RANDOMIZED_ECDSA#

#define PSA_ALG_IS_RANDOMIZED_ECDSA
Value:
(alg)

Definition at line 1566 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_PURE_EDDSA#

#define PSA_ALG_PURE_EDDSA
Value:
((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 1597 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HASH_EDDSA_BASE#

#define PSA_ALG_HASH_EDDSA_BASE
Value:
((psa_algorithm_t) 0x06000900)

Definition at line 1599 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HASH_EDDSA#

#define PSA_ALG_IS_HASH_EDDSA
Value:
(alg)

Definition at line 1600 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ED25519PH#

#define PSA_ALG_ED25519PH
Value:
    (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 1624 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ED448PH#

#define PSA_ALG_ED448PH
Value:
    (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 1649 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_VENDOR_HASH_AND_SIGN#

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN
Value:
(alg)

Definition at line 1655 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_SIGN_HASH#

#define PSA_ALG_IS_SIGN_HASH
Value:
(PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))

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:

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 1674 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_SIGN_MESSAGE#

#define PSA_ALG_IS_SIGN_MESSAGE
Value:
(alg)

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

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 1690 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HASH_AND_SIGN#

#define PSA_ALG_IS_HASH_AND_SIGN
Value:
(PSA_ALG_IS_SIGN_HASH(alg) && \
((alg) & PSA_ALG_HASH_MASK) != 0)

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().

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 1719 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_SIGN_GET_HASH#

#define PSA_ALG_SIGN_GET_HASH
Value:
(PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
0)

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.

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 1741 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_CRYPT#

#define PSA_ALG_RSA_PKCS1V15_CRYPT
Value:
((psa_algorithm_t) 0x07000200)

RSA PKCS#1 v1.5 encryption.


Definition at line 1748 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP_BASE#

#define PSA_ALG_RSA_OAEP_BASE
Value:
((psa_algorithm_t) 0x07000300)

Definition at line 1750 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP#

#define PSA_ALG_RSA_OAEP
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA OAEP encryption algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1765 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RSA_OAEP#

#define PSA_ALG_IS_RSA_OAEP
Value:
(alg)

Definition at line 1767 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP_GET_HASH#

#define PSA_ALG_RSA_OAEP_GET_HASH
Value:
(PSA_ALG_IS_RSA_OAEP(alg) ? \
((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
0)

Definition at line 1769 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_BASE#

#define PSA_ALG_HKDF_BASE
Value:
((psa_algorithm_t) 0x08000100)

Definition at line 1774 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF#

#define PSA_ALG_HKDF
Value:
(hash_alg)

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:

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt used in the "extract" step. It is optional; if omitted, the derivation uses an empty salt.

  • PSA_KEY_DERIVATION_INPUT_SECRET is the secret key used in the "extract" step.

  • PSA_KEY_DERIVATION_INPUT_INFO is the info string used in the "expand" step. You must pass PSA_KEY_DERIVATION_INPUT_SALT before PSA_KEY_DERIVATION_INPUT_SECRET. You may pass PSA_KEY_DERIVATION_INPUT_INFO at any time after steup and before starting to generate output.

    Warnings

    • HKDF processes the salt as follows: first hash it with hash_alg if the salt is longer than the block size of the hash algorithm; then pad with null bytes up to the block size. As a result, it is possible for distinct salt inputs to result in the same outputs. To ensure unique outputs, it is recommended to use a fixed length for salt values.

    Returns

    • The corresponding HKDF algorithm.

    • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1801 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HKDF#

#define PSA_ALG_IS_HKDF
Value:
(alg)

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.

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 1814 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_GET_HASH#

#define PSA_ALG_HKDF_GET_HASH
Value:
(hkdf_alg)

Definition at line 1816 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_EXTRACT_BASE#

#define PSA_ALG_HKDF_EXTRACT_BASE
Value:
((psa_algorithm_t) 0x08000400)

Definition at line 1819 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_EXTRACT#

#define PSA_ALG_HKDF_EXTRACT
Value:
(hash_alg)

Macro to build an HKDF-Extract algorithm.

For example, PSA_ALG_HKDF_EXTRACT(PSA_ALG_SHA_256) is HKDF-Extract using HMAC-SHA-256.

This key derivation algorithm uses the following inputs:

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt.

  • PSA_KEY_DERIVATION_INPUT_SECRET is the input keying material used in the "extract" step. The inputs are mandatory and must be passed in the order above. Each input may only be passed once.

Warnings

  • HKDF-Extract is not meant to be used on its own. PSA_ALG_HKDF should be used instead if possible. PSA_ALG_HKDF_EXTRACT is provided as a separate algorithm for the sake of protocols that use it as a building block. It may also be a slight performance optimization in applications that use HKDF with the same salt and key but many different info strings.

  • HKDF processes the salt as follows: first hash it with hash_alg if the salt is longer than the block size of the hash algorithm; then pad with null bytes up to the block size. As a result, it is possible for distinct salt inputs to result in the same outputs. To ensure unique outputs, it is recommended to use a fixed length for salt values.

Returns

  • The corresponding HKDF-Extract algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1852 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HKDF_EXTRACT#

#define PSA_ALG_IS_HKDF_EXTRACT
Value:
(alg)

Whether the specified algorithm is an HKDF-Extract algorithm.

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

Returns

  • 1 if alg is an HKDF-Extract algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1865 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_EXPAND_BASE#

#define PSA_ALG_HKDF_EXPAND_BASE
Value:
((psa_algorithm_t) 0x08000500)

Definition at line 1868 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_HKDF_EXPAND#

#define PSA_ALG_HKDF_EXPAND
Value:
(hash_alg)

Macro to build an HKDF-Expand algorithm.

For example, PSA_ALG_HKDF_EXPAND(PSA_ALG_SHA_256) is HKDF-Expand using HMAC-SHA-256.

This key derivation algorithm uses the following inputs:

  • PSA_KEY_DERIVATION_INPUT_SECRET is the pseudorandom key (PRK).

  • PSA_KEY_DERIVATION_INPUT_INFO is the info string.

The inputs are mandatory and must be passed in the order above. Each input may only be passed once.

Warnings

  • HKDF-Expand is not meant to be used on its own. PSA_ALG_HKDF should be used instead if possible. PSA_ALG_HKDF_EXPAND is provided as a separate algorithm for the sake of protocols that use it as a building block. It may also be a slight performance optimization in applications that use HKDF with the same salt and key but many different info strings.

Returns

  • The corresponding HKDF-Expand algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1894 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_HKDF_EXPAND#

#define PSA_ALG_IS_HKDF_EXPAND
Value:
(alg)

Whether the specified algorithm is an HKDF-Expand algorithm.

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

Returns

  • 1 if alg is an HKDF-Expand algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1907 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_ANY_HKDF#

#define PSA_ALG_IS_ANY_HKDF
Value:
(((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE || \
((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE || \
((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)

Whether the specified algorithm is an HKDF or HKDF-Extract or HKDF-Expand algorithm.

Returns

  • 1 if alg is any HKDF type algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1920 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF_BASE#

#define PSA_ALG_TLS12_PRF_BASE
Value:
((psa_algorithm_t) 0x08000200)

Definition at line 1925 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF#

#define PSA_ALG_TLS12_PRF
Value:
(hash_alg)

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.

Returns

  • The corresponding TLS-1.2 PRF algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1952 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_TLS12_PRF#

#define PSA_ALG_IS_TLS12_PRF
Value:
(alg)

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

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 1963 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF_GET_HASH#

#define PSA_ALG_TLS12_PRF_GET_HASH
Value:
(hkdf_alg)

Definition at line 1965 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS_BASE#

#define PSA_ALG_TLS12_PSK_TO_MS_BASE
Value:
((psa_algorithm_t) 0x08000300)

Definition at line 1968 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS#

#define PSA_ALG_TLS12_PSK_TO_MS
Value:
(hash_alg)

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, the label is "master secret" or "extended master secret" and the other secret depends on the key exchange specified in the cipher suite:

  • for a plain PSK cipher suite (RFC 4279, Section 2), omit PSA_KEY_DERIVATION_INPUT_OTHER_SECRET

  • for a DHE-PSK (RFC 4279, Section 3) or ECDHE-PSK cipher suite (RFC 5489, Section 2), the other secret should be the output of the PSA_ALG_FFDH or PSA_ALG_ECDH key agreement performed with the peer. The recommended way to pass this input is to use a key derivation algorithm constructed as PSA_ALG_KEY_AGREEMENT(ka_alg, PSA_ALG_TLS12_PSK_TO_MS(hash_alg)) and to call psa_key_derivation_key_agreement(). Alternatively, this input may be an output of psa_raw_key_agreement() passed with psa_key_derivation_input_bytes(), or an equivalent input passed with psa_key_derivation_input_bytes() or psa_key_derivation_input_key().

  • for a RSA-PSK cipher suite (RFC 4279, Section 4), the other secret should be the 48-byte client challenge (the PreMasterSecret of (RFC 5246, Section 7.4.7.1)) concatenation of the TLS version and a 46-byte random string chosen by the client. On the server, this is typically an output of psa_asymmetric_decrypt() using PSA_ALG_RSA_PKCS1V15_CRYPT, passed to the key derivation operation with psa_key_derivation_input_bytes().

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.

Returns

  • The corresponding TLS-1.2 PSK to MS algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 2022 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_TLS12_PSK_TO_MS#

#define PSA_ALG_IS_TLS12_PSK_TO_MS
Value:
(alg)

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

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 2033 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS_GET_HASH#

#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH
Value:
(hkdf_alg)

Definition at line 2035 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_TLS12_ECJPAKE_TO_PMS#

#define PSA_ALG_TLS12_ECJPAKE_TO_PMS
Value:
((psa_algorithm_t) 0x08000609)

Definition at line 2050 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG#

#define PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG
Value:
((psa_algorithm_t) 0x00800000)

Definition at line 2059 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC_BASE#

#define PSA_ALG_PBKDF2_HMAC_BASE
Value:
((psa_algorithm_t) 0x08800100)

Definition at line 2061 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC#

#define PSA_ALG_PBKDF2_HMAC
Value:
(hash_alg)

Macro to build a PBKDF2-HMAC password hashing / key stretching algorithm.

PBKDF2 is defined by PKCS#5, republished as RFC 8018 (section 5.2). This macro specifies the PBKDF2 algorithm constructed using a PRF based on HMAC with the specified hash. For example, PSA_ALG_PBKDF2_HMAC(PSA_ALG_SHA_256) specifies PBKDF2 using the PRF HMAC-SHA-256.

This key derivation algorithm uses the following inputs, which must be provided in the following order:

  • PSA_KEY_DERIVATION_INPUT_COST is the iteration count. This input step must be used exactly once.

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt. This input step must be used one or more times; if used several times, the inputs will be concatenated. This can be used to build the final salt from multiple sources, both public and secret (also known as pepper).

  • PSA_KEY_DERIVATION_INPUT_PASSWORD is the password to be hashed. This input step must be used exactly once.

Returns

  • The corresponding PBKDF2-HMAC-XXX algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 2088 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_PBKDF2_HMAC#

#define PSA_ALG_IS_PBKDF2_HMAC
Value:
(alg)

Whether the specified algorithm is a PBKDF2-HMAC algorithm.

Returns

  • 1 if alg is a PBKDF2-HMAC algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 2099 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC_GET_HASH#

#define PSA_ALG_PBKDF2_HMAC_GET_HASH
Value:
(pbkdf2_alg)

Definition at line 2101 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_PBKDF2_AES_CMAC_PRF_128#

#define PSA_ALG_PBKDF2_AES_CMAC_PRF_128
Value:
((psa_algorithm_t) 0x08800200)

The PBKDF2-AES-CMAC-PRF-128 password hashing / key stretching algorithm.

PBKDF2 is defined by PKCS#5, republished as RFC 8018 (section 5.2). This macro specifies the PBKDF2 algorithm constructed using the AES-CMAC-PRF-128 PRF specified by RFC 4615.

This key derivation algorithm uses the same inputs as PSA_ALG_PBKDF2_HMAC() with the same constraints.


Definition at line 2113 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_PBKDF2#

#define PSA_ALG_IS_PBKDF2
Value:
(PSA_ALG_IS_PBKDF2_HMAC(kdf_alg) || \
((kdf_alg) == PSA_ALG_PBKDF2_AES_CMAC_PRF_128))

Definition at line 2115 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_DERIVATION_MASK#

#define PSA_ALG_KEY_DERIVATION_MASK
Value:
((psa_algorithm_t) 0xfe00ffff)

Definition at line 2119 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_MASK#

#define PSA_ALG_KEY_AGREEMENT_MASK
Value:
((psa_algorithm_t) 0xffff0000)

Definition at line 2120 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT#

#define PSA_ALG_KEY_AGREEMENT
Value:
(ka_alg, kdf_alg)

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

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 2136 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_GET_KDF#

#define PSA_ALG_KEY_AGREEMENT_GET_KDF
Value:
(alg)

Definition at line 2139 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_GET_BASE#

#define PSA_ALG_KEY_AGREEMENT_GET_BASE
Value:
(alg)

Definition at line 2142 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_RAW_KEY_AGREEMENT#

#define PSA_ALG_IS_RAW_KEY_AGREEMENT
Value:
(PSA_ALG_IS_KEY_AGREEMENT(alg) && \
PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == 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().

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 2159 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT#

#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT
Value:
(alg)

Definition at line 2163 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_FFDH#

#define PSA_ALG_FFDH
Value:
((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 2173 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_FFDH#

#define PSA_ALG_IS_FFDH
Value:
(alg)

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.

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 2187 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_ECDH#

#define PSA_ALG_ECDH
Value:
((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 2215 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_ECDH#

#define PSA_ALG_IS_ECDH
Value:
(alg)

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.

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 2231 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_IS_WILDCARD#

#define PSA_ALG_IS_WILDCARD
Value:
(PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
PSA_ALG_IS_MAC(alg) ? \
(alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
PSA_ALG_IS_AEAD(alg) ? \
(alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
(alg) == PSA_ALG_ANY_HASH)

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.

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 2247 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_ALG_GET_HASH#

#define PSA_ALG_GET_HASH
Value:
(alg)

Get the hash used by a composite algorithm.

Returns

  • The underlying hash algorithm if alg is a composite algorithm that uses a hash algorithm.

  • 0 if alg is not a composite algorithm that uses a hash.


Definition at line 2265 of file util/third_party/trusted-firmware-m/interface/include/psa/crypto_values.h

PSA_KEY_TYPE_NONE#

#define PSA_KEY_TYPE_NONE
Value:
((psa_key_type_t) 0x0000)

An invalid key type value.

Zero is not the encoding of any key type.


Definition at line 378 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_VENDOR_FLAG#

#define PSA_KEY_TYPE_VENDOR_FLAG
Value:
((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 387 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_MASK#

#define PSA_KEY_TYPE_CATEGORY_MASK
Value:
((psa_key_type_t) 0x7000)

Definition at line 389 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_RAW#

#define PSA_KEY_TYPE_CATEGORY_RAW
Value:
((psa_key_type_t) 0x1000)

Definition at line 390 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_SYMMETRIC#

#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC
Value:
((psa_key_type_t) 0x2000)

Definition at line 391 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY#

#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY
Value:
((psa_key_type_t) 0x4000)

Definition at line 392 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_KEY_PAIR#

#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR
Value:
((psa_key_type_t) 0x7000)

Definition at line 393 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CATEGORY_FLAG_PAIR#

#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR
Value:
((psa_key_type_t) 0x3000)

Definition at line 395 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_VENDOR_DEFINED#

#define PSA_KEY_TYPE_IS_VENDOR_DEFINED
Value:
(type)

Whether a key type is vendor-defined.

See also PSA_KEY_TYPE_VENDOR_FLAG.


Definition at line 401 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_UNSTRUCTURED#

#define PSA_KEY_TYPE_IS_UNSTRUCTURED
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)

Whether a key type is an unstructured array of bytes.

This encompasses both symmetric keys and non-key data.


Definition at line 408 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ASYMMETRIC#

#define PSA_KEY_TYPE_IS_ASYMMETRIC
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK \
& ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)

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


Definition at line 413 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_PUBLIC_KEY
Value:
(type)

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


Definition at line 418 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_KEY_PAIR#

#define PSA_KEY_TYPE_IS_KEY_PAIR
Value:
(type)

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


Definition at line 422 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY#

#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY
Value:
(type)

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.

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 434 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR#

#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR
Value:
(type)

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.

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 446 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_RAW_DATA#

#define PSA_KEY_TYPE_RAW_DATA
Value:
((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 453 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_HMAC#

#define PSA_KEY_TYPE_HMAC
Value:
((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 463 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DERIVE#

#define PSA_KEY_TYPE_DERIVE
Value:
((psa_key_type_t) 0x1200)

A secret for key derivation.

This key type is for high-entropy secrets only. For low-entropy secrets, PSA_KEY_TYPE_PASSWORD should be used instead.

These keys can be used as the PSA_KEY_DERIVATION_INPUT_SECRET or PSA_KEY_DERIVATION_INPUT_PASSWORD input of key derivation algorithms.

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


Definition at line 476 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_PASSWORD#

#define PSA_KEY_TYPE_PASSWORD
Value:
((psa_key_type_t) 0x1203)

A low-entropy secret for password hashing or key derivation.

This key type is suitable for passwords and passphrases which are typically intended to be memorizable by humans, and have a low entropy relative to their size. It can be used for randomly generated or derived keys with maximum or near-maximum entropy, but PSA_KEY_TYPE_DERIVE is more suitable for such keys. It is not suitable for passwords with extremely low entropy, such as numerical PINs.

These keys can be used as the PSA_KEY_DERIVATION_INPUT_PASSWORD input of key derivation algorithms. Algorithms that accept such an input were designed to accept low-entropy secret and are known as password hashing or key stretching algorithms.

These keys cannot be used as the PSA_KEY_DERIVATION_INPUT_SECRET input of key derivation algorithms, as the algorithms that take such an input expect it to be high-entropy.

The key policy determines which key derivation algorithm the key can be used for, among the permissible subset defined above.


Definition at line 499 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_PASSWORD_HASH#

#define PSA_KEY_TYPE_PASSWORD_HASH
Value:
((psa_key_type_t) 0x1205)

A secret value that can be used to verify a password hash.

The key policy determines which key derivation algorithm the key can be used for, among the same permissible subset as for PSA_KEY_TYPE_PASSWORD.


Definition at line 507 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_PEPPER#

#define PSA_KEY_TYPE_PEPPER
Value:
((psa_key_type_t) 0x1206)

A secret value that can be used in when computing a password hash.

The key policy determines which key derivation algorithm the key can be used for, among the subset of algorithms that can use pepper.


Definition at line 514 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_AES#

#define PSA_KEY_TYPE_AES
Value:
((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 521 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ARIA#

#define PSA_KEY_TYPE_ARIA
Value:
((psa_key_type_t) 0x2406)

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


Definition at line 525 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DES#

#define PSA_KEY_TYPE_DES
Value:
((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 536 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CAMELLIA#

#define PSA_KEY_TYPE_CAMELLIA
Value:
((psa_key_type_t) 0x2403)

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


Definition at line 540 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_CHACHA20#

#define PSA_KEY_TYPE_CHACHA20
Value:
((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.

Note

  • For ChaCha20 and ChaCha20_Poly1305, Mbed TLS only supports 12-byte nonces.

  • For ChaCha20, the initial counter value is 0. To encrypt or decrypt with the initial counter value 1, you can process and discard a 64-byte block before the real data.


Definition at line 553 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_RSA_PUBLIC_KEY#

#define PSA_KEY_TYPE_RSA_PUBLIC_KEY
Value:
((psa_key_type_t) 0x4001)

RSA public key.

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


Definition at line 559 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_RSA_KEY_PAIR#

#define PSA_KEY_TYPE_RSA_KEY_PAIR
Value:
((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 564 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_RSA#

#define PSA_KEY_TYPE_IS_RSA
Value:
(type)

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


Definition at line 566 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE#

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE
Value:
((psa_key_type_t) 0x4100)

Definition at line 569 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_KEY_PAIR_BASE#

#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE
Value:
((psa_key_type_t) 0x7100)

Definition at line 570 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_CURVE_MASK#

#define PSA_KEY_TYPE_ECC_CURVE_MASK
Value:
((psa_key_type_t) 0x00ff)

Definition at line 571 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_KEY_PAIR#

#define PSA_KEY_TYPE_ECC_KEY_PAIR
Value:
(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.


Definition at line 581 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_PUBLIC_KEY#

#define PSA_KEY_TYPE_ECC_PUBLIC_KEY
Value:
(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).


Definition at line 592 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC#

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

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


Definition at line 596 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC_KEY_PAIR#

#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR
Value:
(((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)

Whether a key type is an elliptic curve key pair.


Definition at line 600 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY
Value:
(((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)

Whether a key type is an elliptic curve public key.


Definition at line 604 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_ECC_GET_FAMILY#

#define PSA_KEY_TYPE_ECC_GET_FAMILY
Value:
((psa_ecc_family_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
0))

Extract the curve from an elliptic curve key type.


Definition at line 609 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_IS_WEIERSTRASS#

#define PSA_ECC_FAMILY_IS_WEIERSTRASS
Value:
(family)

Check if the curve of given family is Weierstrass elliptic curve.


Definition at line 615 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_K1#

#define PSA_ECC_FAMILY_SECP_K1
Value:
((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 625 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_R1#

#define PSA_ECC_FAMILY_SECP_R1
Value:
((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 635 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECP_R2#

#define PSA_ECC_FAMILY_SECP_R2
Value:
((psa_ecc_family_t) 0x1b)

Definition at line 637 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_K1#

#define PSA_ECC_FAMILY_SECT_K1
Value:
((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 647 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_R1#

#define PSA_ECC_FAMILY_SECT_R1
Value:
((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 657 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_SECT_R2#

#define PSA_ECC_FAMILY_SECT_R2
Value:
((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 667 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_BRAINPOOL_P_R1#

#define PSA_ECC_FAMILY_BRAINPOOL_P_R1
Value:
((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 676 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_MONTGOMERY#

#define PSA_ECC_FAMILY_MONTGOMERY
Value:
((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 688 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ECC_FAMILY_TWISTED_EDWARDS#

#define PSA_ECC_FAMILY_TWISTED_EDWARDS
Value:
((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 704 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE#

#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE
Value:
((psa_key_type_t) 0x4200)

Definition at line 706 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_KEY_PAIR_BASE#

#define PSA_KEY_TYPE_DH_KEY_PAIR_BASE
Value:
((psa_key_type_t) 0x7200)

Definition at line 707 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_GROUP_MASK#

#define PSA_KEY_TYPE_DH_GROUP_MASK
Value:
((psa_key_type_t) 0x00ff)

Definition at line 708 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_KEY_PAIR#

#define PSA_KEY_TYPE_DH_KEY_PAIR
Value:
(group)

Diffie-Hellman key pair.


Definition at line 714 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_PUBLIC_KEY#

#define PSA_KEY_TYPE_DH_PUBLIC_KEY
Value:
(group)

Diffie-Hellman public key.


Definition at line 721 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH#

#define PSA_KEY_TYPE_IS_DH
Value:
((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)

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


Definition at line 725 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH_KEY_PAIR#

#define PSA_KEY_TYPE_IS_DH_KEY_PAIR
Value:
(((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
PSA_KEY_TYPE_DH_KEY_PAIR_BASE)

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


Definition at line 729 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_IS_DH_PUBLIC_KEY#

#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY
Value:
(((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)

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


Definition at line 733 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DH_GET_FAMILY#

#define PSA_KEY_TYPE_DH_GET_FAMILY
Value:
((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
0))

Extract the group from a Diffie-Hellman key type.


Definition at line 738 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_DH_FAMILY_RFC7919#

#define PSA_DH_FAMILY_RFC7919
Value:
((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 749 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT#

#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT
Value:
(type)

Definition at line 751 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_BLOCK_CIPHER_BLOCK_LENGTH#

#define PSA_BLOCK_CIPHER_BLOCK_LENGTH
Value:
(((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
0u)

The block size of a block cipher.

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.

Warnings

  • This macro may evaluate its argument multiple times.


Definition at line 771 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_VENDOR_FLAG#

#define PSA_ALG_VENDOR_FLAG
Value:
((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 788 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_MASK#

#define PSA_ALG_CATEGORY_MASK
Value:
((psa_algorithm_t) 0x7f000000)

Definition at line 790 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_HASH#

#define PSA_ALG_CATEGORY_HASH
Value:
((psa_algorithm_t) 0x02000000)

Definition at line 791 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_MAC#

#define PSA_ALG_CATEGORY_MAC
Value:
((psa_algorithm_t) 0x03000000)

Definition at line 792 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_CIPHER#

#define PSA_ALG_CATEGORY_CIPHER
Value:
((psa_algorithm_t) 0x04000000)

Definition at line 793 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_AEAD#

#define PSA_ALG_CATEGORY_AEAD
Value:
((psa_algorithm_t) 0x05000000)

Definition at line 794 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_SIGN#

#define PSA_ALG_CATEGORY_SIGN
Value:
((psa_algorithm_t) 0x06000000)

Definition at line 795 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION#

#define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION
Value:
((psa_algorithm_t) 0x07000000)

Definition at line 796 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_KEY_DERIVATION#

#define PSA_ALG_CATEGORY_KEY_DERIVATION
Value:
((psa_algorithm_t) 0x08000000)

Definition at line 797 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CATEGORY_KEY_AGREEMENT#

#define PSA_ALG_CATEGORY_KEY_AGREEMENT
Value:
((psa_algorithm_t) 0x09000000)

Definition at line 798 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_VENDOR_DEFINED#

#define PSA_ALG_IS_VENDOR_DEFINED
Value:
(alg)

Whether an algorithm is vendor-defined.

See also PSA_ALG_VENDOR_FLAG.


Definition at line 804 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HASH#

#define PSA_ALG_IS_HASH
Value:
(alg)

Whether the specified algorithm is a hash algorithm.

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 815 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_MAC#

#define PSA_ALG_IS_MAC
Value:
(alg)

Whether the specified algorithm is a MAC algorithm.

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 826 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_CIPHER#

#define PSA_ALG_IS_CIPHER
Value:
(alg)

Whether the specified algorithm is a symmetric cipher algorithm.

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 837 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_AEAD#

#define PSA_ALG_IS_AEAD
Value:
(alg)

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

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 849 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_SIGN#

#define PSA_ALG_IS_SIGN
Value:
(alg)

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

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 861 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_ASYMMETRIC_ENCRYPTION#

#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION
Value:
(alg)

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

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 873 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_KEY_AGREEMENT#

#define PSA_ALG_IS_KEY_AGREEMENT
Value:
(alg)

Whether the specified algorithm is a key agreement algorithm.

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 884 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION#

#define PSA_ALG_IS_KEY_DERIVATION
Value:
(alg)

Whether the specified algorithm is a key derivation algorithm.

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 895 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION_STRETCHING#

#define PSA_ALG_IS_KEY_DERIVATION_STRETCHING
Value:
(PSA_ALG_IS_KEY_DERIVATION(alg) && \
(alg) & PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG)

Whether the specified algorithm is a key stretching / password hashing algorithm.

A key stretching / password hashing algorithm is a key derivation algorithm that is suitable for use with a low-entropy secret such as a password. Equivalently, it's a key derivation algorithm that uses a PSA_KEY_DERIVATION_INPUT_PASSWORD input step.

Returns

  • 1 if alg is a key stretching / password hashing algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.


Definition at line 912 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_NONE#

#define PSA_ALG_NONE
Value:
((psa_algorithm_t)0)

An invalid algorithm identifier value.


Definition at line 918 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HASH_MASK#

#define PSA_ALG_HASH_MASK
Value:
((psa_algorithm_t) 0x000000ff)

Definition at line 921 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_MD5#

#define PSA_ALG_MD5
Value:
((psa_algorithm_t) 0x02000003)

MD5.


Definition at line 923 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RIPEMD160#

#define PSA_ALG_RIPEMD160
Value:
((psa_algorithm_t) 0x02000004)

PSA_ALG_RIPEMD160.


Definition at line 925 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_1#

#define PSA_ALG_SHA_1
Value:
((psa_algorithm_t) 0x02000005)

SHA1.


Definition at line 927 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_224#

#define PSA_ALG_SHA_224
Value:
((psa_algorithm_t) 0x02000008)

SHA2-224.


Definition at line 929 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_256#

#define PSA_ALG_SHA_256
Value:
((psa_algorithm_t) 0x02000009)

SHA2-256.


Definition at line 931 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_384#

#define PSA_ALG_SHA_384
Value:
((psa_algorithm_t) 0x0200000a)

SHA2-384.


Definition at line 933 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_512#

#define PSA_ALG_SHA_512
Value:
((psa_algorithm_t) 0x0200000b)

SHA2-512.


Definition at line 935 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_512_224#

#define PSA_ALG_SHA_512_224
Value:
((psa_algorithm_t) 0x0200000c)

SHA2-512/224.


Definition at line 937 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA_512_256#

#define PSA_ALG_SHA_512_256
Value:
((psa_algorithm_t) 0x0200000d)

SHA2-512/256.


Definition at line 939 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA3_224#

#define PSA_ALG_SHA3_224
Value:
((psa_algorithm_t) 0x02000010)

SHA3-224.


Definition at line 941 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA3_256#

#define PSA_ALG_SHA3_256
Value:
((psa_algorithm_t) 0x02000011)

SHA3-256.


Definition at line 943 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA3_384#

#define PSA_ALG_SHA3_384
Value:
((psa_algorithm_t) 0x02000012)

SHA3-384.


Definition at line 945 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHA3_512#

#define PSA_ALG_SHA3_512
Value:
((psa_algorithm_t) 0x02000013)

SHA3-512.


Definition at line 947 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SHAKE256_512#

#define PSA_ALG_SHAKE256_512
Value:
((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 954 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ANY_HASH#

#define PSA_ALG_ANY_HASH
Value:
((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:

  • PSA_ALG_RSA_PKCS1V15_SIGN, PSA_ALG_RSA_PSS, PSA_ALG_RSA_PSS_ANY_SALT,

  • PSA_ALG_ECDSA, PSA_ALG_DETERMINISTIC_ECDSA. Then you may create and use a key as follows:

  • Set the key usage field using PSA_ALG_ANY_HASH, for example:

    psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH); // or VERIFY
    psa_set_key_algorithm(&attributes, PSA_xxx_SIGNATURE(PSA_ALG_ANY_HASH));
    
  • Import or generate key material.

  • Call psa_sign_hash() or psa_verify_hash(), passing an algorithm built from PSA_xxx_SIGNATURE and a specific hash. Each call to sign or verify a message may use a different hash.

    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA_256), ...);
    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA_512), ...);
    psa_sign_hash(key, PSA_xxx_SIGNATURE(PSA_ALG_SHA3_256), ...);
    

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 989 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_MAC_SUBCATEGORY_MASK#

#define PSA_ALG_MAC_SUBCATEGORY_MASK
Value:
((psa_algorithm_t) 0x00c00000)

Definition at line 991 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HMAC_BASE#

#define PSA_ALG_HMAC_BASE
Value:
((psa_algorithm_t) 0x03800000)

Definition at line 992 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HMAC#

#define PSA_ALG_HMAC
Value:
(hash_alg)

Macro to build an HMAC algorithm.

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

Returns

  • The corresponding HMAC algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1004 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HMAC_GET_HASH#

#define PSA_ALG_HMAC_GET_HASH
Value:
(hmac_alg)

Definition at line 1007 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HMAC#

#define PSA_ALG_IS_HMAC
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
PSA_ALG_HMAC_BASE)

Whether the specified algorithm is an HMAC algorithm.

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

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 1020 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_MAC_TRUNCATION_MASK#

#define PSA_ALG_MAC_TRUNCATION_MASK
Value:
((psa_algorithm_t) 0x003f0000)

Definition at line 1031 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_MAC_TRUNCATION_OFFSET#

#define PSA_MAC_TRUNCATION_OFFSET
Value:
16

Definition at line 1032 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG#

#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG
Value:
((psa_algorithm_t) 0x00008000)

Definition at line 1040 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TRUNCATED_MAC#

#define PSA_ALG_TRUNCATED_MAC
Value:
(((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)) | \
((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))

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.

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 1075 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_FULL_LENGTH_MAC#

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

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

Returns

  • The corresponding base MAC algorithm.

  • Unspecified if mac_alg is not a supported MAC algorithm.


Definition at line 1092 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_MAC_TRUNCATED_LENGTH#

#define PSA_MAC_TRUNCATED_LENGTH
Value:
(mac_alg)

Length to which a MAC algorithm is truncated.

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 1107 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AT_LEAST_THIS_LENGTH_MAC#

#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC
Value:
(PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)

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.

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 1134 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CIPHER_MAC_BASE#

#define PSA_ALG_CIPHER_MAC_BASE
Value:
((psa_algorithm_t) 0x03c00000)

Definition at line 1138 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CBC_MAC#

#define PSA_ALG_CBC_MAC
Value:
((psa_algorithm_t) 0x03c00100)

The CBC-MAC construction over a block cipher.

Warnings

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


Definition at line 1144 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CMAC#

#define PSA_ALG_CMAC
Value:
((psa_algorithm_t) 0x03c00200)

The CMAC construction over a block cipher.


Definition at line 1146 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_BLOCK_CIPHER_MAC#

#define PSA_ALG_IS_BLOCK_CIPHER_MAC
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
PSA_ALG_CIPHER_MAC_BASE)

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

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 1156 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CIPHER_STREAM_FLAG#

#define PSA_ALG_CIPHER_STREAM_FLAG
Value:
((psa_algorithm_t) 0x00800000)

Definition at line 1160 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CIPHER_FROM_BLOCK_FLAG#

#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG
Value:
((psa_algorithm_t) 0x00400000)

Definition at line 1161 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_STREAM_CIPHER#

#define PSA_ALG_IS_STREAM_CIPHER
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
(PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))

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.

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 1175 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_STREAM_CIPHER#

#define PSA_ALG_STREAM_CIPHER
Value:
((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 1184 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CTR#

#define PSA_ALG_CTR
Value:
((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 1193 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CFB#

#define PSA_ALG_CFB
Value:
((psa_algorithm_t) 0x04c01100)

The CFB stream cipher mode.

The underlying block cipher is determined by the key type.


Definition at line 1199 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_OFB#

#define PSA_ALG_OFB
Value:
((psa_algorithm_t) 0x04c01200)

The OFB stream cipher mode.

The underlying block cipher is determined by the key type.


Definition at line 1205 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_XTS#

#define PSA_ALG_XTS
Value:
((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 1213 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECB_NO_PADDING#

#define PSA_ALG_ECB_NO_PADDING
Value:
((psa_algorithm_t) 0x04404400)

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

Warnings

  • 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 1233 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CBC_NO_PADDING#

#define PSA_ALG_CBC_NO_PADDING
Value:
((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 1242 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CBC_PKCS7#

#define PSA_ALG_CBC_PKCS7
Value:
((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 1250 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_FROM_BLOCK_FLAG#

#define PSA_ALG_AEAD_FROM_BLOCK_FLAG
Value:
((psa_algorithm_t) 0x00400000)

Definition at line 1252 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER#

#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER
Value:
(((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
(PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))

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

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 1263 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CCM#

#define PSA_ALG_CCM
Value:
((psa_algorithm_t) 0x05500100)

The CCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.


Definition at line 1271 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CCM_STAR_NO_TAG#

#define PSA_ALG_CCM_STAR_NO_TAG
Value:
((psa_algorithm_t) 0x04c01300)

The CCM* cipher mode without authentication.

This is CCM* as specified in IEEE 802.15.4 §7, with a tag length of 0. For CCM* with a nonzero tag length, use the AEAD algorithm PSA_ALG_CCM.

The underlying block cipher is determined by the key type.

Currently only 13-byte long IV's are supported.


Definition at line 1282 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_GCM#

#define PSA_ALG_GCM
Value:
((psa_algorithm_t) 0x05500200)

The GCM authenticated encryption algorithm.

The underlying block cipher is determined by the key type.


Definition at line 1288 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_CHACHA20_POLY1305#

#define PSA_ALG_CHACHA20_POLY1305
Value:
((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 1299 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_TAG_LENGTH_MASK#

#define PSA_ALG_AEAD_TAG_LENGTH_MASK
Value:
((psa_algorithm_t) 0x003f0000)

Definition at line 1305 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_AEAD_TAG_LENGTH_OFFSET#

#define PSA_AEAD_TAG_LENGTH_OFFSET
Value:
16

Definition at line 1306 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG#

#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG
Value:
((psa_algorithm_t) 0x00008000)

Definition at line 1314 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_SHORTENED_TAG#

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

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.

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 1334 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_GET_TAG_LENGTH#

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

Retrieve the tag length of a specified AEAD algorithm.

Returns

  • The tag length specified by the input algorithm.

  • Unspecified if aead_alg is not a supported AEAD algorithm.


Definition at line 1350 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG#

#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG
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)

Calculate the corresponding AEAD algorithm with the default tag length.

Returns

  • The corresponding AEAD algorithm with the default tag length for that algorithm.


Definition at line 1362 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE#

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

Definition at line 1368 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG#

#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG
Value:
(PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)

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.

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 1397 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN_BASE#

#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE
Value:
((psa_algorithm_t) 0x06000200)

Definition at line 1401 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN#

#define PSA_ALG_RSA_PKCS1V15_SIGN
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PKCS#1 v1.5 signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1417 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_SIGN_RAW#

#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW
Value:
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 1425 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PKCS1V15_SIGN#

#define PSA_ALG_IS_RSA_PKCS1V15_SIGN
Value:
(alg)

Definition at line 1426 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_BASE#

#define PSA_ALG_RSA_PSS_BASE
Value:
((psa_algorithm_t) 0x06000300)

Definition at line 1429 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_ANY_SALT_BASE#

#define PSA_ALG_RSA_PSS_ANY_SALT_BASE
Value:
((psa_algorithm_t) 0x06001300)

Definition at line 1430 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PSS#

#define PSA_ALG_RSA_PSS
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PSS signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1451 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PSS_ANY_SALT#

#define PSA_ALG_RSA_PSS_ANY_SALT
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA PSS signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1469 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS_STANDARD_SALT#

#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT
Value:
(alg)

Whether the specified algorithm is RSA PSS with standard salt.

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 1483 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS_ANY_SALT#

#define PSA_ALG_IS_RSA_PSS_ANY_SALT
Value:
(alg)

Whether the specified algorithm is RSA PSS with any salt.

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 1497 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RSA_PSS#

#define PSA_ALG_IS_RSA_PSS
Value:
(PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) || \
PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))

Whether the specified algorithm is RSA PSS.

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

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 1515 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDSA_BASE#

#define PSA_ALG_ECDSA_BASE
Value:
((psa_algorithm_t) 0x06000600)

Definition at line 1519 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDSA#

#define PSA_ALG_ECDSA
Value:
(hash_alg)

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).

Returns

  • The corresponding ECDSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1540 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDSA_ANY#

#define PSA_ALG_ECDSA_ANY
Value:
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 1551 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_DETERMINISTIC_ECDSA_BASE#

#define PSA_ALG_DETERMINISTIC_ECDSA_BASE
Value:
((psa_algorithm_t) 0x06000700)

Definition at line 1552 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_DETERMINISTIC_ECDSA#

#define PSA_ALG_DETERMINISTIC_ECDSA
Value:
(hash_alg)

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.

Returns

  • The corresponding deterministic ECDSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1575 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDSA_DETERMINISTIC_FLAG#

#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG
Value:
((psa_algorithm_t) 0x00000100)

Definition at line 1577 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_ECDSA#

#define PSA_ALG_IS_ECDSA
Value:
(((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
PSA_ALG_ECDSA_BASE)

Definition at line 1578 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDSA_IS_DETERMINISTIC#

#define PSA_ALG_ECDSA_IS_DETERMINISTIC
Value:
(alg)

Definition at line 1581 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_DETERMINISTIC_ECDSA#

#define PSA_ALG_IS_DETERMINISTIC_ECDSA
Value:
(alg)

Definition at line 1583 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RANDOMIZED_ECDSA#

#define PSA_ALG_IS_RANDOMIZED_ECDSA
Value:
(alg)

Definition at line 1585 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_PURE_EDDSA#

#define PSA_ALG_PURE_EDDSA
Value:
((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 1616 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HASH_EDDSA_BASE#

#define PSA_ALG_HASH_EDDSA_BASE
Value:
((psa_algorithm_t) 0x06000900)

Definition at line 1618 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HASH_EDDSA#

#define PSA_ALG_IS_HASH_EDDSA
Value:
(alg)

Definition at line 1619 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ED25519PH#

#define PSA_ALG_ED25519PH
Value:
    (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 1643 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ED448PH#

#define PSA_ALG_ED448PH
Value:
    (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 1668 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_VENDOR_HASH_AND_SIGN#

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN
Value:
(alg)

Definition at line 1674 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_SIGN_HASH#

#define PSA_ALG_IS_SIGN_HASH
Value:
(PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))

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:

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 1693 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_SIGN_MESSAGE#

#define PSA_ALG_IS_SIGN_MESSAGE
Value:
(alg)

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

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 1709 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HASH_AND_SIGN#

#define PSA_ALG_IS_HASH_AND_SIGN
Value:
(PSA_ALG_IS_SIGN_HASH(alg) && \
((alg) & PSA_ALG_HASH_MASK) != 0)

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().

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 1738 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_SIGN_GET_HASH#

#define PSA_ALG_SIGN_GET_HASH
Value:
(PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
0)

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.

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 1760 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_PKCS1V15_CRYPT#

#define PSA_ALG_RSA_PKCS1V15_CRYPT
Value:
((psa_algorithm_t) 0x07000200)

RSA PKCS#1 v1.5 encryption.


Definition at line 1767 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP_BASE#

#define PSA_ALG_RSA_OAEP_BASE
Value:
((psa_algorithm_t) 0x07000300)

Definition at line 1769 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP#

#define PSA_ALG_RSA_OAEP
Value:
(hash_alg)

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.

Returns

  • The corresponding RSA OAEP encryption algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1784 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RSA_OAEP#

#define PSA_ALG_IS_RSA_OAEP
Value:
(alg)

Definition at line 1786 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_RSA_OAEP_GET_HASH#

#define PSA_ALG_RSA_OAEP_GET_HASH
Value:
(PSA_ALG_IS_RSA_OAEP(alg) ? \
((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
0)

Definition at line 1788 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_BASE#

#define PSA_ALG_HKDF_BASE
Value:
((psa_algorithm_t) 0x08000100)

Definition at line 1793 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF#

#define PSA_ALG_HKDF
Value:
(hash_alg)

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:

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt used in the "extract" step. It is optional; if omitted, the derivation uses an empty salt.

  • PSA_KEY_DERIVATION_INPUT_SECRET is the secret key used in the "extract" step.

  • PSA_KEY_DERIVATION_INPUT_INFO is the info string used in the "expand" step. You must pass PSA_KEY_DERIVATION_INPUT_SALT before PSA_KEY_DERIVATION_INPUT_SECRET. You may pass PSA_KEY_DERIVATION_INPUT_INFO at any time after steup and before starting to generate output.

    Warnings

    • HKDF processes the salt as follows: first hash it with hash_alg if the salt is longer than the block size of the hash algorithm; then pad with null bytes up to the block size. As a result, it is possible for distinct salt inputs to result in the same outputs. To ensure unique outputs, it is recommended to use a fixed length for salt values.

    Returns

    • The corresponding HKDF algorithm.

    • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1820 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HKDF#

#define PSA_ALG_IS_HKDF
Value:
(alg)

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.

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 1833 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_GET_HASH#

#define PSA_ALG_HKDF_GET_HASH
Value:
(hkdf_alg)

Definition at line 1835 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_EXTRACT_BASE#

#define PSA_ALG_HKDF_EXTRACT_BASE
Value:
((psa_algorithm_t) 0x08000400)

Definition at line 1838 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_EXTRACT#

#define PSA_ALG_HKDF_EXTRACT
Value:
(hash_alg)

Macro to build an HKDF-Extract algorithm.

For example, PSA_ALG_HKDF_EXTRACT(PSA_ALG_SHA_256) is HKDF-Extract using HMAC-SHA-256.

This key derivation algorithm uses the following inputs:

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt.

  • PSA_KEY_DERIVATION_INPUT_SECRET is the input keying material used in the "extract" step. The inputs are mandatory and must be passed in the order above. Each input may only be passed once.

Warnings

  • HKDF-Extract is not meant to be used on its own. PSA_ALG_HKDF should be used instead if possible. PSA_ALG_HKDF_EXTRACT is provided as a separate algorithm for the sake of protocols that use it as a building block. It may also be a slight performance optimization in applications that use HKDF with the same salt and key but many different info strings.

  • HKDF processes the salt as follows: first hash it with hash_alg if the salt is longer than the block size of the hash algorithm; then pad with null bytes up to the block size. As a result, it is possible for distinct salt inputs to result in the same outputs. To ensure unique outputs, it is recommended to use a fixed length for salt values.

Returns

  • The corresponding HKDF-Extract algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1871 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HKDF_EXTRACT#

#define PSA_ALG_IS_HKDF_EXTRACT
Value:
(alg)

Whether the specified algorithm is an HKDF-Extract algorithm.

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

Returns

  • 1 if alg is an HKDF-Extract algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1884 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_EXPAND_BASE#

#define PSA_ALG_HKDF_EXPAND_BASE
Value:
((psa_algorithm_t) 0x08000500)

Definition at line 1887 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_HKDF_EXPAND#

#define PSA_ALG_HKDF_EXPAND
Value:
(hash_alg)

Macro to build an HKDF-Expand algorithm.

For example, PSA_ALG_HKDF_EXPAND(PSA_ALG_SHA_256) is HKDF-Expand using HMAC-SHA-256.

This key derivation algorithm uses the following inputs:

  • PSA_KEY_DERIVATION_INPUT_SECRET is the pseudorandom key (PRK).

  • PSA_KEY_DERIVATION_INPUT_INFO is the info string.

The inputs are mandatory and must be passed in the order above. Each input may only be passed once.

Warnings

  • HKDF-Expand is not meant to be used on its own. PSA_ALG_HKDF should be used instead if possible. PSA_ALG_HKDF_EXPAND is provided as a separate algorithm for the sake of protocols that use it as a building block. It may also be a slight performance optimization in applications that use HKDF with the same salt and key but many different info strings.

Returns

  • The corresponding HKDF-Expand algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1913 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_HKDF_EXPAND#

#define PSA_ALG_IS_HKDF_EXPAND
Value:
(alg)

Whether the specified algorithm is an HKDF-Expand algorithm.

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

Returns

  • 1 if alg is an HKDF-Expand algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1926 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_ANY_HKDF#

#define PSA_ALG_IS_ANY_HKDF
Value:
(((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE || \
((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE || \
((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)

Whether the specified algorithm is an HKDF or HKDF-Extract or HKDF-Expand algorithm.

Returns

  • 1 if alg is any HKDF type algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 1939 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF_BASE#

#define PSA_ALG_TLS12_PRF_BASE
Value:
((psa_algorithm_t) 0x08000200)

Definition at line 1944 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF#

#define PSA_ALG_TLS12_PRF
Value:
(hash_alg)

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.

Returns

  • The corresponding TLS-1.2 PRF algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 1971 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_TLS12_PRF#

#define PSA_ALG_IS_TLS12_PRF
Value:
(alg)

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

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 1982 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PRF_GET_HASH#

#define PSA_ALG_TLS12_PRF_GET_HASH
Value:
(hkdf_alg)

Definition at line 1984 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS_BASE#

#define PSA_ALG_TLS12_PSK_TO_MS_BASE
Value:
((psa_algorithm_t) 0x08000300)

Definition at line 1987 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS#

#define PSA_ALG_TLS12_PSK_TO_MS
Value:
(hash_alg)

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, the label is "master secret" or "extended master secret" and the other secret depends on the key exchange specified in the cipher suite:

  • for a plain PSK cipher suite (RFC 4279, Section 2), omit PSA_KEY_DERIVATION_INPUT_OTHER_SECRET

  • for a DHE-PSK (RFC 4279, Section 3) or ECDHE-PSK cipher suite (RFC 5489, Section 2), the other secret should be the output of the PSA_ALG_FFDH or PSA_ALG_ECDH key agreement performed with the peer. The recommended way to pass this input is to use a key derivation algorithm constructed as PSA_ALG_KEY_AGREEMENT(ka_alg, PSA_ALG_TLS12_PSK_TO_MS(hash_alg)) and to call psa_key_derivation_key_agreement(). Alternatively, this input may be an output of psa_raw_key_agreement() passed with psa_key_derivation_input_bytes(), or an equivalent input passed with psa_key_derivation_input_bytes() or psa_key_derivation_input_key().

  • for a RSA-PSK cipher suite (RFC 4279, Section 4), the other secret should be the 48-byte client challenge (the PreMasterSecret of (RFC 5246, Section 7.4.7.1)) concatenation of the TLS version and a 46-byte random string chosen by the client. On the server, this is typically an output of psa_asymmetric_decrypt() using PSA_ALG_RSA_PKCS1V15_CRYPT, passed to the key derivation operation with psa_key_derivation_input_bytes().

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.

Returns

  • The corresponding TLS-1.2 PSK to MS algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 2041 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_TLS12_PSK_TO_MS#

#define PSA_ALG_IS_TLS12_PSK_TO_MS
Value:
(alg)

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

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 2052 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_PSK_TO_MS_GET_HASH#

#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH
Value:
(hkdf_alg)

Definition at line 2054 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_TLS12_ECJPAKE_TO_PMS#

#define PSA_ALG_TLS12_ECJPAKE_TO_PMS
Value:
((psa_algorithm_t) 0x08000609)

Definition at line 2069 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG#

#define PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG
Value:
((psa_algorithm_t) 0x00800000)

Definition at line 2078 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC_BASE#

#define PSA_ALG_PBKDF2_HMAC_BASE
Value:
((psa_algorithm_t) 0x08800100)

Definition at line 2080 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC#

#define PSA_ALG_PBKDF2_HMAC
Value:
(hash_alg)

Macro to build a PBKDF2-HMAC password hashing / key stretching algorithm.

PBKDF2 is defined by PKCS#5, republished as RFC 8018 (section 5.2). This macro specifies the PBKDF2 algorithm constructed using a PRF based on HMAC with the specified hash. For example, PSA_ALG_PBKDF2_HMAC(PSA_ALG_SHA_256) specifies PBKDF2 using the PRF HMAC-SHA-256.

This key derivation algorithm uses the following inputs, which must be provided in the following order:

  • PSA_KEY_DERIVATION_INPUT_COST is the iteration count. This input step must be used exactly once.

  • PSA_KEY_DERIVATION_INPUT_SALT is the salt. This input step must be used one or more times; if used several times, the inputs will be concatenated. This can be used to build the final salt from multiple sources, both public and secret (also known as pepper).

  • PSA_KEY_DERIVATION_INPUT_PASSWORD is the password to be hashed. This input step must be used exactly once.

Returns

  • The corresponding PBKDF2-HMAC-XXX algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 2107 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_PBKDF2_HMAC#

#define PSA_ALG_IS_PBKDF2_HMAC
Value:
(alg)

Whether the specified algorithm is a PBKDF2-HMAC algorithm.

Returns

  • 1 if alg is a PBKDF2-HMAC algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported key derivation algorithm identifier.


Definition at line 2118 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_PBKDF2_HMAC_GET_HASH#

#define PSA_ALG_PBKDF2_HMAC_GET_HASH
Value:
(pbkdf2_alg)

Definition at line 2120 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_PBKDF2_AES_CMAC_PRF_128#

#define PSA_ALG_PBKDF2_AES_CMAC_PRF_128
Value:
((psa_algorithm_t) 0x08800200)

The PBKDF2-AES-CMAC-PRF-128 password hashing / key stretching algorithm.

PBKDF2 is defined by PKCS#5, republished as RFC 8018 (section 5.2). This macro specifies the PBKDF2 algorithm constructed using the AES-CMAC-PRF-128 PRF specified by RFC 4615.

This key derivation algorithm uses the same inputs as PSA_ALG_PBKDF2_HMAC() with the same constraints.


Definition at line 2131 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_PBKDF2#

#define PSA_ALG_IS_PBKDF2
Value:
(PSA_ALG_IS_PBKDF2_HMAC(kdf_alg) || \
((kdf_alg) == PSA_ALG_PBKDF2_AES_CMAC_PRF_128))

Definition at line 2133 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_DERIVATION_MASK#

#define PSA_ALG_KEY_DERIVATION_MASK
Value:
((psa_algorithm_t) 0xfe00ffff)

Definition at line 2137 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_MASK#

#define PSA_ALG_KEY_AGREEMENT_MASK
Value:
((psa_algorithm_t) 0xffff0000)

Definition at line 2138 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT#

#define PSA_ALG_KEY_AGREEMENT
Value:
(ka_alg, kdf_alg)

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

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 2154 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_GET_KDF#

#define PSA_ALG_KEY_AGREEMENT_GET_KDF
Value:
(alg)

Definition at line 2157 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_KEY_AGREEMENT_GET_BASE#

#define PSA_ALG_KEY_AGREEMENT_GET_BASE
Value:
(alg)

Definition at line 2160 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_RAW_KEY_AGREEMENT#

#define PSA_ALG_IS_RAW_KEY_AGREEMENT
Value:
(PSA_ALG_IS_KEY_AGREEMENT(alg) && \
PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == 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().

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 2177 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT#

#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT
Value:
(alg)

Definition at line 2181 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_FFDH#

#define PSA_ALG_FFDH
Value:
((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 2191 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_FFDH#

#define PSA_ALG_IS_FFDH
Value:
(alg)

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.

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 2205 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_ECDH#

#define PSA_ALG_ECDH
Value:
((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 2233 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_ECDH#

#define PSA_ALG_IS_ECDH
Value:
(alg)

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.

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 2249 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_IS_WILDCARD#

#define PSA_ALG_IS_WILDCARD
Value:
(PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
PSA_ALG_IS_MAC(alg) ? \
(alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
PSA_ALG_IS_AEAD(alg) ? \
(alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
(alg) == PSA_ALG_ANY_HASH)

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.

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 2265 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_ALG_GET_HASH#

#define PSA_ALG_GET_HASH
Value:
(alg)

Get the hash used by a composite algorithm.

Returns

  • The underlying hash algorithm if alg is a composite algorithm that uses a hash algorithm.

  • 0 if alg is not a composite algorithm that uses a hash.


Definition at line 2283 of file util/third_party/mbedtls/include/psa/crypto_values.h

PSA_KEY_TYPE_DSA_PUBLIC_KEY#

#define PSA_KEY_TYPE_DSA_PUBLIC_KEY
Value:
((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 347 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_KEY_TYPE_DSA_KEY_PAIR#

#define PSA_KEY_TYPE_DSA_KEY_PAIR
Value:
((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 365 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_KEY_TYPE_IS_DSA#

#define PSA_KEY_TYPE_IS_DSA
Value:
(type)

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


Definition at line 368 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DSA_BASE#

#define PSA_ALG_DSA_BASE
Value:
((psa_algorithm_t) 0x06000400)

Definition at line 371 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DSA#

#define PSA_ALG_DSA
Value:
(hash_alg)

DSA signature with hashing.

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

Returns

  • The corresponding DSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 386 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DETERMINISTIC_DSA_BASE#

#define PSA_ALG_DETERMINISTIC_DSA_BASE
Value:
((psa_algorithm_t) 0x06000500)

Definition at line 388 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DSA_DETERMINISTIC_FLAG#

#define PSA_ALG_DSA_DETERMINISTIC_FLAG
Value:
PSA_ALG_ECDSA_DETERMINISTIC_FLAG

Definition at line 389 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DETERMINISTIC_DSA#

#define PSA_ALG_DETERMINISTIC_DSA
Value:
(hash_alg)

Deterministic DSA signature with hashing.

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

Returns

  • The corresponding DSA signature algorithm.

  • Unspecified if hash_alg is not a supported hash algorithm.


Definition at line 404 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_IS_DSA#

#define PSA_ALG_IS_DSA
Value:
(((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_DSA_DETERMINISTIC_FLAG) == \
PSA_ALG_DSA_BASE)

Definition at line 406 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_DSA_IS_DETERMINISTIC#

#define PSA_ALG_DSA_IS_DETERMINISTIC
Value:
(alg)

Definition at line 409 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_IS_DETERMINISTIC_DSA#

#define PSA_ALG_IS_DETERMINISTIC_DSA
Value:
(alg)

Definition at line 411 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_IS_RANDOMIZED_DSA#

#define PSA_ALG_IS_RANDOMIZED_DSA
Value:
(alg)

Definition at line 413 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_IS_VENDOR_HASH_AND_SIGN#

#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN
Value:
(alg)

Definition at line 420 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_CATEGORY_PAKE#

#define PSA_ALG_CATEGORY_PAKE
Value:
((psa_algorithm_t) 0x0a000000)

Definition at line 780 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_IS_PAKE#

#define PSA_ALG_IS_PAKE
Value:
(alg)

Whether the specified algorithm is a password-authenticated key exchange.

Returns

  • 1 if alg is a password-authenticated key exchange (PAKE) algorithm, 0 otherwise. This macro may return either 0 or 1 if alg is not a supported algorithm identifier.


Definition at line 791 of file util/third_party/mbedtls/include/psa/crypto_extra.h

PSA_ALG_JPAKE#

#define PSA_ALG_JPAKE
Value:
((psa_algorithm_t) 0x0a000100)

The Password-authenticated key exchange by juggling (J-PAKE) algorithm.

This is J-PAKE as defined by RFC 8236, instantiated with the following parameters:

  • The group can be either an elliptic curve or defined over a finite field.

  • Schnorr NIZK proof as defined by RFC 8235 and using the same group as the J-PAKE algorithm.

  • A cryptographic hash function.

To select these parameters and set up the cipher suite, call these functions in any order:

psa_pake_cs_set_algorithm(cipher_suite, PSA_ALG_JPAKE);
psa_pake_cs_set_primitive(cipher_suite,
                          PSA_PAKE_PRIMITIVE(type, family, bits));
psa_pake_cs_set_hash(cipher_suite, hash);

For more information on how to set a specific curve or field, refer to the documentation of the individual PSA_PAKE_PRIMITIVE_TYPE_XXX constants.

After initializing a J-PAKE operation, call

psa_pake_setup(operation, cipher_suite);
psa_pake_set_user(operation, ...);
psa_pake_set_peer(operation, ...);
psa_pake_set_password_key(operation, ...);

The password is provided as a key. This can be the password text itself, in an agreed character encoding, or some value derived from the password as required by a higher level protocol.

(The implementation converts the key material to a number as described in Section 2.3.8 of SEC 1: Elliptic Curve Cryptography (https://www.secg.org/sec1-v2.pdf), before reducing it modulo q. Here q is order of the group defined by the primitive set in the cipher suite. The psa_pake_set_password_key() function returns an error if the result of the reduction is 0.)

The key exchange flow for J-PAKE is as follows:

  1. To get the first round data that needs to be sent to the peer, call

    // Get g1
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get the ZKP public key for x1
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get the ZKP proof for x1
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    // Get g2
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get the ZKP public key for x2
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get the ZKP proof for x2
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  2. To provide the first round data received from the peer to the operation, call

    // Set g3
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set the ZKP public key for x3
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set the ZKP proof for x3
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    // Set g4
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set the ZKP public key for x4
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set the ZKP proof for x4
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  3. To get the second round data that needs to be sent to the peer, call

    // Get A
    psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Get ZKP public key for x2*s
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Get ZKP proof for x2*s
    psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  4. To provide the second round data received from the peer to the operation, call

    // Set B
    psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
    // Set ZKP public key for x4*s
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
    // Set ZKP proof for x4*s
    psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
    
  5. To access the shared secret call

    // Get Ka=Kb=K
    psa_pake_get_implicit_key()
    

For more information consult the documentation of the individual PSA_PAKE_STEP_XXX constants.

At this point there is a cryptographic guarantee that only the authenticated party who used the same password is able to compute the key. But there is no guarantee that the peer is the party it claims to be and was able to do so.

That is, the authentication is only implicit (the peer is not authenticated at this point, and no action should be taken that assume that they are - like for example accessing restricted files).

To make the authentication explicit there are various methods, see Section 5 of RFC 8236 for two examples.


Definition at line 909 of file util/third_party/mbedtls/include/psa/crypto_extra.h