Module Psa.Key_type

Key types.

Key types

type t

The type for for psa_key_type.

val none : t

PSA_KEY_TYPE_NONE.

Key categories

val is_unstructured : t -> bool

PSA_KEY_TYPE_IS_UNSTRUCTURED

val is_asymmetric : t -> bool

PSA_KEY_TYPE_IS_ASYMMETRIC

val is_public_key : t -> bool

PSA_KEY_TYPE_IS_PUBLIC_KEY

val is_key_pair : t -> bool

PSA_KEY_TYPE_IS_KEY_PAIR

Symmetric keys

val raw_data : t

PSA_KEY_TYPE_RAW_DATA

val hmac : t

PSA_KEY_TYPE_HMAC

val derive : t

PSA_KEY_TYPE_DERIVE

val password : t

PSA_KEY_TYPE_PASSWORD

val password_hash : t

PSA_KEY_TYPE_PASSWORD_HASH

val pepper : t

PSA_KEY_TYPE_PEPPER

val aes : t

PSA_KEY_TYPE_AES

val aria : t

PSA_KEY_TYPE_ARIA

val des : t

PSA_KEY_TYPE_DES WARNING Weak and strongly deprecated.

val camellia : t

PSA_KEY_TYPE_CAMELLIA

val sm4 : t

PSA_KEY_TYPE_SM4

val arc4 : t

PSA_KEY_TYPE_ARC4 WARNING Weak and strongly deprecated.

val chacha20 : t

PSA_KEY_TYPE_CHACHA20

val xchacha20 : t

PSA_KEY_TYPE_XCHACHA20

RSA keys

val rsa_key_pair : t

PSA_KEY_TYPE_RSA_KEY_PAIR

val rsa_public_key : t

PSA_KEY_TYPE_RSA_PUBLIC_KEY

val is_rsa : t -> bool

PSA_KEY_TYPE_IS_RSA

Elliptic curve keys

See also Ecc_family.

val ecc_key_pair : Ecc_family.t -> t

PSA_KEY_TYPE_ECC_KEY_PAIR

val ecc_public_key : Ecc_family.t -> t

PSA_KEY_TYPE_ECC_PUBLIC_KEY

val is_ecc : t -> bool

PSA_KEY_TYPE_IS_ECC

val is_ecc_key_pair : t -> bool

PSA_KEY_TYPE_IS_ECC_KEY_PAIR

val is_ecc_public_key : t -> bool

PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY

val ecc_get_family : t -> Ecc_family.t

PSA_KEY_TYPE_ECC_GET_FAMILY

Diffie-Hellman keys

See also Dh_family.

val dh_key_pair : Dh_family.t -> t

PSA_KEY_TYPE_DH_KEY_PAIR

val dh_public_key : Dh_family.t -> t

PSA_KEY_TYPE_DH_PUBLIC_KEY

val is_dh : t -> bool

PSA_KEY_TYPE_IS_DH

val is_dh_key_pair : t -> bool

PSA_KEY_TYPE_IS_DH_KEY_PAIR

val is_dh_public_key : t -> bool

PSA_KEY_TYPE_IS_DH_PUBLIC_KEY

val dh_get_family : t -> Dh_family.t

PSA_KEY_TYPE_DH_GET_FAMILY

Generic public keys

val key_pair_of_public_key : t -> t

PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY

val public_key_of_key_pair : t -> t

PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR

Predicates and comparisons

val equal : t -> t -> bool

equal t0 t1 is true iff t0 and t1 are equal.

val compare : t -> t -> int

compare is a total order compatible with equal.

Converting

val to_uint16 : t -> uint16

to_uint16 t is t as an unsigned 16-bit integer.

val of_uint16 : uint16 -> t

of_uint16 i is a key type from i.

Formatting

val pp : Stdlib.Format.formatter -> t -> unit

pp formats key types for inspection.