Skip to content

HORIZON HASKELL Docs lts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulehpke-0.0.0Haskell2010

Crypto.HPKE

Hybrid Public Key Encryption (RFC9180).

16 types
10 values

Packagehpke-0.0.0
Exports37
LanguageHaskell2010
LicenceBSD-3-Clause
SourceHPKE.hs

IDs

14 declarations

newtypenewtype KEM_ID

ID for key encapsulation mechanism.

Constructors

KEM_ID
- fromKEM_ID :: Word16

Instances2Eq, Show

Eq KEM_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID
Show KEM_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID

patternpattern DHKEM_P256_HKDF_SHA256 :: KEM_ID

patternpattern DHKEM_P384_HKDF_SHA384 :: KEM_ID

patternpattern DHKEM_P521_HKDF_SHA512 :: KEM_ID

patternpattern DHKEM_X25519_HKDF_SHA256 :: KEM_ID

patternpattern DHKEM_X448_HKDF_SHA512 :: KEM_ID

newtypenewtype KDF_ID

ID for key derivation function.

Constructors

KDF_ID
- fromKDF_ID :: Word16

Instances2Eq, Show

Eq KDF_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID
Show KDF_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID

patternpattern HKDF_SHA256 :: KDF_ID

patternpattern HKDF_SHA384 :: KDF_ID

patternpattern HKDF_SHA512 :: KDF_ID

newtypenewtype AEAD_ID

ID for authenticated encryption with additional data

Constructors

AEAD_ID
- fromAEAD_ID :: Word16

Instances2Eq, Show

Eq AEAD_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID
Show AEAD_IDDefined in hpke-0.0.0 · Crypto.HPKE.ID

patternpattern AES_128_GCM :: AEAD_ID

patternpattern AES_256_GCM :: AEAD_ID

patternpattern ChaCha20Poly1305 :: AEAD_ID

Setup

0 declarations

For mode_base and mode_auth

valuesetupBaseS

:: KEM_ID
-> KDF_ID
-> AEAD_ID
-> Maybe EncodedSecretKey
My ephemeral secret key. Automatically generated if Nothing
-> Maybe EncodedSecretKey
My secret key for authentication. mode_base is used if Nothing. base_auth is used, otherwise.
-> EncodedPublicKey
Peer's public key.
-> Info
-> IO (EncodedPublicKey, ContextS)

Setting up base/auth mode for a sender. This throws HPKEError.

valuesetupBaseR

:: KEM_ID
-> KDF_ID
-> AEAD_ID
-> EncodedSecretKey
My secret key
-> Maybe EncodedSecretKey
My secret key for authentication. mode_base is used if Nothing. base_auth is used, otherwise.
-> EncodedPublicKey
Peer's public key.
-> Info
-> IO ContextR

Setting up base/auth mode for a receiver with its key pair. This throws HPKEError.

For mode_psk and mode_auth_psk

valuesetupPSKS

:: KEM_ID
-> KDF_ID
-> AEAD_ID
-> Maybe EncodedSecretKey
My ephemeral secret key. Automatically generated if Nothing
-> Maybe EncodedSecretKey
My secret key for authentication. mode_base is used if Nothing. base_auth is used, otherwise.
-> EncodedPublicKey
Peer's public key.
-> Info
-> PSK
-> PSK_ID
-> IO (EncodedPublicKey, ContextS)

Setting up psk/auth_psk mode for a sender. This throws HPKEError.

valuesetupPSKR

:: KEM_ID
-> KDF_ID
-> AEAD_ID
-> EncodedSecretKey
My secret key
-> Maybe EncodedSecretKey
My secret key for authentication. mode_base is used if Nothing. base_auth is used, otherwise.
-> EncodedPublicKey
Peer's public key.
-> Info
-> PSK
-> PSK_ID
-> IO ContextR

Setting up psk/auth_psk mode for a receiver with its key pair. This throws HPKEError.

Encryption and Decyption

2 declarations

valueseal :: ContextS -> AAD -> PlainText -> IO CipherText

Encryption. This throws HPKEError.

valueopen :: ContextR -> AAD -> CipherText -> IO PlainText

Decryption. This throws HPKEError.

Secret export

2 declarations

valueexportS :: ContextS -> Info -> Int -> Key

Exporting secret.

valueexportR :: ContextR -> Info -> Int -> Key

Exporting secret.

Types

12 declarations

datadata ContextS

Context for senders.

datadata ContextR

Context for receivers.

newtypenewtype EncodedSecretKey

Encoded secret key.

Constructors

EncodedSecretKey ByteString

Instances3Eq, Show, IsString

Eq EncodedSecretKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types
Show EncodedSecretKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types
IsString EncodedSecretKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types

newtypenewtype EncodedPublicKey

Encoded public key.

Constructors

EncodedPublicKey ByteString

Instances3Eq, Show, IsString

Eq EncodedPublicKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types
Show EncodedPublicKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types
IsString EncodedPublicKeyDefined in hpke-0.0.0 · Crypto.HPKE.Types

newtypenewtype SharedSecret

Secret shared via key exchange

Constructors

SharedSecret ScrubbedBytes

Instances5Eq, Semigroup, Monoid, NFData, ByteArrayAccess

Eq SharedSecretDefined in crypton-1.0.4 · Crypto.ECC
Semigroup SharedSecretDefined in crypton-1.0.4 · Crypto.ECC
Monoid SharedSecretDefined in crypton-1.0.4 · Crypto.ECC
NFData SharedSecretDefined in crypton-1.0.4 · Crypto.ECC
ByteArrayAccess SharedSecretDefined in crypton-1.0.4 · Crypto.ECC

typetype Info = ByteString

Information string.

typetype PSK = ByteString

Pre-shared key.

typetype PSK_ID = ByteString

ID for pre-shared key.

typetype AAD = ByteString

Additional authenticated data for AEAD.

typetype PlainText = ByteString

Plain text.

typetype CipherText = ByteString

Cipher text (including a authentication tag)

typetype Key = ByteString

Encryption key.

Error

1 declaration

datadata HPKEError

Errors for HPKE

Constructors

ValidationError String
DeserializeError String
EncapError String
DecapError String
SealError String
Original
OpenError String
MessageLimitReachedError String
DeriveKeyPairError String
KeyScheduleError String
Original
Unsupported String

Instances3Eq, Show, Exception

Eq HPKEErrorDefined in hpke-0.0.0 · Crypto.HPKE.Types
Show HPKEErrorDefined in hpke-0.0.0 · Crypto.HPKE.Types
Exception HPKEErrorDefined in hpke-0.0.0 · Crypto.HPKE.Types

Misc

2 declarations

valuenEnc :: KEM_ID -> Int

Length of "enc", aka sender's public key.

valuenTag :: AEAD_ID -> Int

Length of AEAD tag.