Data.CryptoID.Class

Polymorphic functions to perform cryptographic operations on CryptoIDs in a monadic context

Documentation

class MonadThrow m => MonadCrypto (m :: * -> *) where

Class of monads granting reader access to a key and allowing for failure during cryptographic operations

This formulation is weaker than MonadReader key (from mtl) in that it does not require local.

Minimal complete definition

cryptoIDKey

Associated Types

type MonadCryptoKey m :: *

Methods

cryptoIDKey :: (MonadCryptoKey m -> m a) -> m a

class MonadCrypto m => HasCryptoID (namespace :: Symbol) (ciphertext :: *) (plaintext :: *) (m :: * -> *) where

Multiparameter typeclass of (namespace, ciphertext, plaintext, monad) tuples which allow for cryptographic operations on CryptoIDs with appropriate namespace, plaintext, and ciphertext, utilising the state of monad

Instances of this typeclass are usually universally quantified over (at least) namespace, and m

Minimal complete definition

encrypt, decrypt

Methods

encrypt :: plaintext -> m (CryptoID namespace ciphertext)

Encrypt a plaintext in a fashion dependent on the namespace and desired ciphertext-type retrieving the key from and throwing errors into m

decrypt :: CryptoID namespace ciphertext -> m plaintext

Encrypt a ciphertext in a fashion dependent on the namespace and desired plaintext-type retrieving the key from and throwing errors into m