hpke-0.4.0: Crypto/HPKE.hs

-- | Hybrid Public Key Encryption (RFC9180).
module Crypto.HPKE (
    -- * IDs
    KEM_ID (..),
    KDF_ID (..),
    AEAD_ID (..),

    -- * Setup

    -- ** For mode_base and mode_auth
    setupBaseS,
    setupBaseR,

    -- ** For mode_psk and mode_auth_psk
    setupPSKS,
    setupPSKR,

    -- * Encryption and Decyption
    seal,
    open,

    -- * Secret export
    exportS,
    exportR,

    -- * Types
    ContextS,
    ContextR,
    EncodedSecretKey (..),
    EncodedPublicKey (..),
    SharedSecret (..),
    Info,
    PSK,
    PSK_ID,
    AAD,
    PlainText,
    CipherText,
    Key,

    -- * Error
    HPKEError (..),

    -- * Misc
    nEnc,
    nTag,
) where

import Crypto.HPKE.Context
import Crypto.HPKE.ID
import Crypto.HPKE.Setup
import Crypto.HPKE.Types

-- | Length of "enc", aka sender's public key.
--   'Nothing' for a KEM not registered in RFC 9180.
{- FOURMOLU_DISABLE -}
nEnc :: KEM_ID -> Maybe Int
nEnc DHKEM_P256_HKDF_SHA256   = Just  65
nEnc DHKEM_P384_HKDF_SHA384   = Just  97
nEnc DHKEM_P521_HKDF_SHA512   = Just 133
nEnc DHKEM_X25519_HKDF_SHA256 = Just  32
nEnc DHKEM_X448_HKDF_SHA512   = Just  56
nEnc _                        = Nothing
{- FOURMOLU_ENABLE -}

-- | Length of AEAD tag.
--   'Nothing' for an AEAD not registered in RFC 9180.
{- FOURMOLU_DISABLE -}
nTag :: AEAD_ID -> Maybe Int
nTag AES_128_GCM      = Just 16
nTag AES_256_GCM      = Just 16
nTag ChaCha20Poly1305 = Just 16
nTag _                = Nothing
{- FOURMOLU_ENABLE -}