ConfCrypt.Encryption

This exposes the interface and instances for handling encryption/decryption. The interface for each operation is intentionally split.

Working with RSA keys

class KeyProjection key

This class provides the ability to extract specific parts of a keypair from a given RSA KeyPair

Minimal complete definition

project

Instances

KeyProjection PublicKey

Defined in ConfCrypt.Encryption

Methods

project :: KeyPair -> PublicKey

KeyProjection PrivateKey

Defined in ConfCrypt.Encryption

Methods

project :: KeyPair -> PrivateKey

project :: KeyProjection key => KeyPair -> key

data TextKey key where

Represents the textual contents of any key stored on the local machine

Constructors

TextKey :: LocalKey key => key -> TextKey key

Instances

(MonadRandom m, MonadError ConfCryptError m, Monad m) => MonadEncrypt m (TextKey PublicKey)

Defined in ConfCrypt.Encryption

Methods

encryptValue :: TextKey PublicKey -> Text -> m Text

(MonadError ConfCryptError m, Monad m) => MonadDecrypt m (TextKey PrivateKey)

Defined in ConfCrypt.Encryption

Methods

decryptValue :: TextKey PrivateKey -> Text -> m Text

data RemoteKey key where

Represents a KMS key remotely managed by a third party service provider.

Constructors

RemoteKey :: KMSKey key => key -> RemoteKey key

Instances

MonadEncrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx)

Defined in ConfCrypt.Encryption

Methods

encryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text

MonadDecrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx)

Defined in ConfCrypt.Encryption

Methods

decryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text

Working with values

data Encrypted

Instances

Eq Encrypted

Defined in ConfCrypt.Encryption

Methods

(==) :: Encrypted -> Encrypted -> Bool

(/=) :: Encrypted -> Encrypted -> Bool

Show Encrypted

Defined in ConfCrypt.Encryption

Methods

showsPrec :: Int -> Encrypted -> ShowS

show :: Encrypted -> String

showList :: [Encrypted] -> ShowS

renderEncrypted :: Encrypted -> Text

class (Monad m, MonadError ConfCryptError m) => MonadEncrypt m k

The interface for encrypting a value is simply a function from a key + plaintext -> ciphertext.

Minimal complete definition

encryptValue

Instances

(Monad m, MonadRandom m, MonadError ConfCryptError m) => MonadEncrypt m PublicKey

Defined in ConfCrypt.Encryption

Methods

encryptValue :: PublicKey -> Text -> m Text

(MonadRandom m, MonadError ConfCryptError m, Monad m) => MonadEncrypt m (TextKey PublicKey)

Defined in ConfCrypt.Encryption

Methods

encryptValue :: TextKey PublicKey -> Text -> m Text

MonadEncrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx)

Defined in ConfCrypt.Encryption

Methods

encryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text

encryptValue :: MonadEncrypt m k => k -> Text -> m Text

Encrypts a value and either returns the ciphertext or throws a ConfCryptError

class (Monad m, MonadError ConfCryptError m) => MonadDecrypt m k

Decrypts an encrypted block of text

Minimal complete definition

decryptValue

Instances

(Monad m, MonadError ConfCryptError m) => MonadDecrypt m PrivateKey

Defined in ConfCrypt.Encryption

Methods

decryptValue :: PrivateKey -> Text -> m Text

(MonadError ConfCryptError m, Monad m) => MonadDecrypt m (TextKey PrivateKey)

Defined in ConfCrypt.Encryption

Methods

decryptValue :: TextKey PrivateKey -> Text -> m Text

MonadDecrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx)

Defined in ConfCrypt.Encryption

Methods

decryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text

decryptValue :: MonadDecrypt m k => k -> Text -> m Text

Given a key and some encrypted ciphertext, returns either the decrypted plaintext or raises a ConfCryptError

Utilities

loadRSAKey :: (MonadIO m, Monad m, MonadError ConfCryptError m, KeyProjection key) => FilePath -> m key

Given a file on disk that contains the textual representation of an RSA private key (as generated by openssh or ssh-keygen), extract the key from the file and project it into the type of key required.

Exported for Testing

unpackPrivateRSAKey :: MonadError ConfCryptError m => ByteString -> m KeyPair

A private function to actually unpack the RSA key. Only used for testing

Orphan instances

KMSKey AWSCtx

LocalKey PublicKey

LocalKey PrivateKey

MonadRandom m => MonadRandom (ExceptT e m)

Methods

getRandomBytes :: ByteArray byteArray => Int -> ExceptT e m byteArray

MonadRandom m => MonadRandom (ConfCryptM m k)

Methods

getRandomBytes :: ByteArray byteArray => Int -> ConfCryptM m k byteArray