Copyright	(c) 2018 Chris Coffey (c) 2018 CollegeVine
License	MIT
Maintainer	Chris Coffey
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

ConfCrypt.Types

Contents

Core types
Helpers
Orphan instances

Description

Core types and some small helper functions used to construct ConfCrypt.

Synopsis

type ConfCryptM m ctx = ReaderT (ConfCryptFile, ctx) (ExceptT ConfCryptError (ResourceT m))
data ConfCryptError
- = ParserError Text
- | NonRSAKey
- | KeyUnpackingError Text
- | DecryptionError Text
- | AWSDecryptionError Text
- | AWSEncryptionError Text
- | EncryptionError Error
- | MissingLine Text
- | UnknownParameter Text
- | WrongFileAction Text
- | CleanupError Text
data ConfCryptFile = ConfCryptFile {
- fileName :: Text
- fileContents :: Map ConfCryptElement LineNumber
- parameters :: [Parameter]
}
data Parameter = Parameter {
- paramName :: Text
- paramValue :: Text
- paramType :: Maybe SchemaType
}
data ConfCryptElement
- = SchemaLine Schema
- | CommentLine {
  - cText :: Text
  }
- | ParameterLine ParamLine
newtype LineNumber = LineNumber Int
data SchemaType
- = CString
- | CInt
- | CBoolean
data ParamLine = ParamLine {
- pName :: Text
- pValue :: Text
}
data Schema = Schema {
- sName :: Text
- sType :: SchemaType
}
class LocalKey key
class KMSKey key
unWrapSchema :: ConfCryptElement -> Maybe Schema
isParameter :: ConfCryptElement -> Bool
typeToOutputString :: SchemaType -> Text
parameterToLines :: Parameter -> (ParamLine, Maybe Schema)

Core types

type ConfCryptM m ctx = ReaderT (ConfCryptFile, ctx) (ExceptT ConfCryptError (ResourceT m)) #

The core transformer stack for ConfCrypt. The most important parts are the ReaderT and ResourceT, as ExceptT can be replaced with explicit return type.

Errors

data ConfCryptError #

The possible errors produced during a confcrypt operation.

Instances

Eq ConfCryptError #
Instance details Defined in ConfCrypt.Types Methods (==) :: ConfCryptError -> ConfCryptError -> Bool # (/=) :: ConfCryptError -> ConfCryptError -> Bool #
Ord ConfCryptError #
Instance details Defined in ConfCrypt.Types Methods compare :: ConfCryptError -> ConfCryptError -> Ordering # (<) :: ConfCryptError -> ConfCryptError -> Bool # (<=) :: ConfCryptError -> ConfCryptError -> Bool # (>) :: ConfCryptError -> ConfCryptError -> Bool # (>=) :: ConfCryptError -> ConfCryptError -> Bool # max :: ConfCryptError -> ConfCryptError -> ConfCryptError # min :: ConfCryptError -> ConfCryptError -> ConfCryptError #
Show ConfCryptError #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> ConfCryptError -> ShowS # show :: ConfCryptError -> String # showList :: [ConfCryptError] -> ShowS #
Generic ConfCryptError #
Instance details Defined in ConfCrypt.Types Associated Types type Rep ConfCryptError :: Type -> Type # Methods from :: ConfCryptError -> Rep ConfCryptError x # to :: Rep ConfCryptError x -> ConfCryptError #
Monad m => Command NewConfCrypt (ConfCryptM m ()) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: NewConfCrypt -> ConfCryptM m () [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command ValidateConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: ValidateConfCrypt -> ConfCryptM m key [Text] #
Monad m => Command DeleteConfCrypt (ConfCryptM m ()) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: DeleteConfCrypt -> ConfCryptM m () [Text] #
(Monad m, MonadRandom m, MonadEncrypt (ConfCryptM m key) key) => Command EditConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: EditConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadRandom m, MonadEncrypt (ConfCryptM m key) key) => Command AddConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: AddConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command GetConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: GetConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command ReadConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: ReadConfCrypt -> ConfCryptM m key [Text] #
MonadRandom m => MonadRandom (ConfCryptM m k) #
Instance details Defined in ConfCrypt.Encryption Methods getRandomBytes :: ByteArray byteArray => Int -> ConfCryptM m k byteArray #
MonadEncrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx) #
Instance details Defined in ConfCrypt.Encryption Methods encryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text #
MonadDecrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx) #
Instance details Defined in ConfCrypt.Encryption Methods decryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text #
type Rep ConfCryptError #
Instance details Defined in ConfCrypt.Types type Rep ConfCryptError = D1 (MetaData "ConfCryptError" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (((C1 (MetaCons "ParserError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "NonRSAKey" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "KeyUnpackingError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "DecryptionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "AWSDecryptionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))) :+: ((C1 (MetaCons "AWSEncryptionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "EncryptionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Error)) :+: C1 (MetaCons "MissingLine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))) :+: (C1 (MetaCons "UnknownParameter" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "WrongFileAction" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "CleanupError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

Runtime Environment

data ConfCryptFile #

As indicated in the Readme, a ConfCrypt file

Constructors

ConfCryptFile
Fields fileName :: Text fileContents :: Map ConfCryptElement LineNumber parameters :: [Parameter]

Instances

Show ConfCryptFile #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> ConfCryptFile -> ShowS # show :: ConfCryptFile -> String # showList :: [ConfCryptFile] -> ShowS #
Generic ConfCryptFile #
Instance details Defined in ConfCrypt.Types Associated Types type Rep ConfCryptFile :: Type -> Type # Methods from :: ConfCryptFile -> Rep ConfCryptFile x # to :: Rep ConfCryptFile x -> ConfCryptFile #
NFData ConfCryptFile #
Instance details Defined in ConfCrypt.Types Methods rnf :: ConfCryptFile -> () #
Monad m => Command NewConfCrypt (ConfCryptM m ()) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: NewConfCrypt -> ConfCryptM m () [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command ValidateConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: ValidateConfCrypt -> ConfCryptM m key [Text] #
Monad m => Command DeleteConfCrypt (ConfCryptM m ()) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: DeleteConfCrypt -> ConfCryptM m () [Text] #
(Monad m, MonadRandom m, MonadEncrypt (ConfCryptM m key) key) => Command EditConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: EditConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadRandom m, MonadEncrypt (ConfCryptM m key) key) => Command AddConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: AddConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command GetConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: GetConfCrypt -> ConfCryptM m key [Text] #
(Monad m, MonadDecrypt (ConfCryptM m key) key) => Command ReadConfCrypt (ConfCryptM m key) #
Instance details Defined in ConfCrypt.Commands Methods evaluate :: ReadConfCrypt -> ConfCryptM m key [Text] #
HasEnv (ConfCryptFile, AWSCtx) #
Instance details Defined in ConfCrypt.Providers.AWS Methods environment :: Lens' (ConfCryptFile, AWSCtx) Env # envRegion :: Lens' (ConfCryptFile, AWSCtx) Region # envLogger :: Lens' (ConfCryptFile, AWSCtx) Logger # envRetryCheck :: Lens' (ConfCryptFile, AWSCtx) (Int -> HttpException -> Bool) # envOverride :: Lens' (ConfCryptFile, AWSCtx) (Dual (Endo Service)) # envManager :: Lens' (ConfCryptFile, AWSCtx) Manager # envAuth :: Lens' (ConfCryptFile, AWSCtx) Auth # envEC2 :: Getter (ConfCryptFile, AWSCtx) (IORef (Maybe Bool)) #
MonadRandom m => MonadRandom (ConfCryptM m k) #
Instance details Defined in ConfCrypt.Encryption Methods getRandomBytes :: ByteArray byteArray => Int -> ConfCryptM m k byteArray #
MonadEncrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx) #
Instance details Defined in ConfCrypt.Encryption Methods encryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text #
MonadDecrypt (ConfCryptM IO (RemoteKey AWSCtx)) (RemoteKey AWSCtx) #
Instance details Defined in ConfCrypt.Encryption Methods decryptValue :: RemoteKey AWSCtx -> Text -> ConfCryptM IO (RemoteKey AWSCtx) Text #
type Rep ConfCryptFile #
Instance details Defined in ConfCrypt.Types type Rep ConfCryptFile = D1 (MetaData "ConfCryptFile" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "ConfCryptFile" PrefixI True) (S1 (MetaSel (Just "fileName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "fileContents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map ConfCryptElement LineNumber)) :: S1 (MetaSel (Just "parameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Parameter]))))

data Parameter #

A parameter consists of both a ParamLine and Schema line from the confcr

Constructors

Parameter
Fields paramName :: Text paramValue :: Text paramType :: Maybe SchemaType

Instances

Eq Parameter #
Instance details Defined in ConfCrypt.Types Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Ord Parameter #
Instance details Defined in ConfCrypt.Types Methods compare :: Parameter -> Parameter -> Ordering # (<) :: Parameter -> Parameter -> Bool # (<=) :: Parameter -> Parameter -> Bool # (>) :: Parameter -> Parameter -> Bool # (>=) :: Parameter -> Parameter -> Bool # max :: Parameter -> Parameter -> Parameter # min :: Parameter -> Parameter -> Parameter #
Show Parameter #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
Generic Parameter #
Instance details Defined in ConfCrypt.Types Associated Types type Rep Parameter :: Type -> Type # Methods from :: Parameter -> Rep Parameter x # to :: Rep Parameter x -> Parameter #
NFData Parameter #
Instance details Defined in ConfCrypt.Types Methods rnf :: Parameter -> () #
type Rep Parameter #
Instance details Defined in ConfCrypt.Types type Rep Parameter = D1 (MetaData "Parameter" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "Parameter" PrefixI True) (S1 (MetaSel (Just "paramName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "paramValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "paramType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SchemaType)))))

File Format

data ConfCryptElement #

The syntax used to describe a confcrypt file. A line in a confcrypt file may be one of Schema, ParamLine, or comment. The grammar itself is described in the readme and Parser.

Constructors

SchemaLine Schema
CommentLine
Fields cText :: Text
ParameterLine ParamLine

Instances

Eq ConfCryptElement #	this implementation means that there can only be a single parameter or schema with the same name. Attempting to add multiple with the same name is undefined behavior and will result in missing data.
Instance details Defined in ConfCrypt.Types Methods (==) :: ConfCryptElement -> ConfCryptElement -> Bool # (/=) :: ConfCryptElement -> ConfCryptElement -> Bool #
Ord ConfCryptElement #	In order to
Instance details Defined in ConfCrypt.Types Methods compare :: ConfCryptElement -> ConfCryptElement -> Ordering # (<) :: ConfCryptElement -> ConfCryptElement -> Bool # (<=) :: ConfCryptElement -> ConfCryptElement -> Bool # (>) :: ConfCryptElement -> ConfCryptElement -> Bool # (>=) :: ConfCryptElement -> ConfCryptElement -> Bool # max :: ConfCryptElement -> ConfCryptElement -> ConfCryptElement # min :: ConfCryptElement -> ConfCryptElement -> ConfCryptElement #
Show ConfCryptElement #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> ConfCryptElement -> ShowS # show :: ConfCryptElement -> String # showList :: [ConfCryptElement] -> ShowS #
Generic ConfCryptElement #
Instance details Defined in ConfCrypt.Types Associated Types type Rep ConfCryptElement :: Type -> Type # Methods from :: ConfCryptElement -> Rep ConfCryptElement x # to :: Rep ConfCryptElement x -> ConfCryptElement #
NFData ConfCryptElement #
Instance details Defined in ConfCrypt.Types Methods rnf :: ConfCryptElement -> () #
type Rep ConfCryptElement #
Instance details Defined in ConfCrypt.Types type Rep ConfCryptElement = D1 (MetaData "ConfCryptElement" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "SchemaLine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema)) :+: (C1 (MetaCons "CommentLine" PrefixI True) (S1 (MetaSel (Just "cText") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "ParameterLine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamLine))))

newtype LineNumber #

Self explanitory

Constructors

LineNumber Int

Instances

Eq LineNumber #
Instance details Defined in ConfCrypt.Types Methods (==) :: LineNumber -> LineNumber -> Bool # (/=) :: LineNumber -> LineNumber -> Bool #
Ord LineNumber #
Instance details Defined in ConfCrypt.Types Methods compare :: LineNumber -> LineNumber -> Ordering # (<) :: LineNumber -> LineNumber -> Bool # (<=) :: LineNumber -> LineNumber -> Bool # (>) :: LineNumber -> LineNumber -> Bool # (>=) :: LineNumber -> LineNumber -> Bool # max :: LineNumber -> LineNumber -> LineNumber # min :: LineNumber -> LineNumber -> LineNumber #
Show LineNumber #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> LineNumber -> ShowS # show :: LineNumber -> String # showList :: [LineNumber] -> ShowS #
Generic LineNumber #
Instance details Defined in ConfCrypt.Types Associated Types type Rep LineNumber :: Type -> Type # Methods from :: LineNumber -> Rep LineNumber x # to :: Rep LineNumber x -> LineNumber #
NFData LineNumber #
Instance details Defined in ConfCrypt.Types Methods rnf :: LineNumber -> () #
type Rep LineNumber #
Instance details Defined in ConfCrypt.Types type Rep LineNumber = D1 (MetaData "LineNumber" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" True) (C1 (MetaCons "LineNumber" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

data SchemaType #

Indicates which types a

Constructors

CString	Maps to `String`
CInt	Maps to `Int`
CBoolean	Maps to `Bool`

Instances

Eq SchemaType #
Instance details Defined in ConfCrypt.Types Methods (==) :: SchemaType -> SchemaType -> Bool # (/=) :: SchemaType -> SchemaType -> Bool #
Ord SchemaType #
Instance details Defined in ConfCrypt.Types Methods compare :: SchemaType -> SchemaType -> Ordering # (<) :: SchemaType -> SchemaType -> Bool # (<=) :: SchemaType -> SchemaType -> Bool # (>) :: SchemaType -> SchemaType -> Bool # (>=) :: SchemaType -> SchemaType -> Bool # max :: SchemaType -> SchemaType -> SchemaType # min :: SchemaType -> SchemaType -> SchemaType #
Read SchemaType #
Instance details Defined in ConfCrypt.Types Methods readsPrec :: Int -> ReadS SchemaType # readList :: ReadS [SchemaType] # readPrec :: ReadPrec SchemaType # readListPrec :: ReadPrec [SchemaType] #
Show SchemaType #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> SchemaType -> ShowS # show :: SchemaType -> String # showList :: [SchemaType] -> ShowS #
Generic SchemaType #
Instance details Defined in ConfCrypt.Types Associated Types type Rep SchemaType :: Type -> Type # Methods from :: SchemaType -> Rep SchemaType x # to :: Rep SchemaType x -> SchemaType #
NFData SchemaType #
Instance details Defined in ConfCrypt.Types Methods rnf :: SchemaType -> () #
type Rep SchemaType #
Instance details Defined in ConfCrypt.Types type Rep SchemaType = D1 (MetaData "SchemaType" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "CString" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CInt" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CBoolean" PrefixI False) (U1 :: Type -> Type)))

data ParamLine #

A parsed parameter line from a confcrypt file

Constructors

ParamLine
Fields pName :: Text pValue :: Text

Instances

Eq ParamLine #
Instance details Defined in ConfCrypt.Types Methods (==) :: ParamLine -> ParamLine -> Bool # (/=) :: ParamLine -> ParamLine -> Bool #
Ord ParamLine #
Instance details Defined in ConfCrypt.Types Methods compare :: ParamLine -> ParamLine -> Ordering # (<) :: ParamLine -> ParamLine -> Bool # (<=) :: ParamLine -> ParamLine -> Bool # (>) :: ParamLine -> ParamLine -> Bool # (>=) :: ParamLine -> ParamLine -> Bool # max :: ParamLine -> ParamLine -> ParamLine # min :: ParamLine -> ParamLine -> ParamLine #
Show ParamLine #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> ParamLine -> ShowS # show :: ParamLine -> String # showList :: [ParamLine] -> ShowS #
Generic ParamLine #
Instance details Defined in ConfCrypt.Types Associated Types type Rep ParamLine :: Type -> Type # Methods from :: ParamLine -> Rep ParamLine x # to :: Rep ParamLine x -> ParamLine #
NFData ParamLine #
Instance details Defined in ConfCrypt.Types Methods rnf :: ParamLine -> () #
type Rep ParamLine #
Instance details Defined in ConfCrypt.Types type Rep ParamLine = D1 (MetaData "ParamLine" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "ParamLine" PrefixI True) (S1 (MetaSel (Just "pName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "pValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Schema #

A parsed schema line from a confcrypt file

Constructors

Schema
Fields sName :: Text sType :: SchemaType

Instances

Eq Schema #
Instance details Defined in ConfCrypt.Types Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #
Ord Schema #
Instance details Defined in ConfCrypt.Types Methods compare :: Schema -> Schema -> Ordering # (<) :: Schema -> Schema -> Bool # (<=) :: Schema -> Schema -> Bool # (>) :: Schema -> Schema -> Bool # (>=) :: Schema -> Schema -> Bool # max :: Schema -> Schema -> Schema # min :: Schema -> Schema -> Schema #
Show Schema #
Instance details Defined in ConfCrypt.Types Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
Generic Schema #
Instance details Defined in ConfCrypt.Types Associated Types type Rep Schema :: Type -> Type # Methods from :: Schema -> Rep Schema x # to :: Rep Schema x -> Schema #
NFData Schema #
Instance details Defined in ConfCrypt.Types Methods rnf :: Schema -> () #
type Rep Schema #
Instance details Defined in ConfCrypt.Types type Rep Schema = D1 (MetaData "Schema" "ConfCrypt.Types" "confcrypt-0.1.0.4-DVHvSaFYzUh4p1s8F9TW6i" False) (C1 (MetaCons "Schema" PrefixI True) (S1 (MetaSel (Just "sName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "sType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SchemaType)))

Key constraints

class LocalKey key #

This constraint provides a type-level check that the wrapped key type is local to the current machine. For use with things like RSA keys.

Instances

LocalKey PublicKey #
Instance details Defined in ConfCrypt.Encryption
LocalKey PrivateKey #
Instance details Defined in ConfCrypt.Encryption

class KMSKey key #

This constraint provides a type-level check that the wrapped key type exists off-system inside an externally provided Key Management System (KMS). For use with AWS KMS or Azure KMS.

Instances

KMSKey AWSCtx #
Instance details Defined in ConfCrypt.Encryption

Helpers

unWrapSchema :: ConfCryptElement -> Maybe Schema #

Attempts to unwrap a line from a confcrypt file into a Schema

isParameter :: ConfCryptElement -> Bool #

Checks whether the provided line from a confcrypt file is a Parameter

typeToOutputString :: SchemaType -> Text #

A special purpose Show function for convert

parameterToLines :: Parameter -> (ParamLine, Maybe Schema) #

Convert a parameter into a ParameterLine and SchemaLine if possible.

Orphan instances

Ord Error #
Instance details Methods compare :: Error -> Error -> Ordering # (<) :: Error -> Error -> Bool # (<=) :: Error -> Error -> Bool # (>) :: Error -> Error -> Bool # (>=) :: Error -> Error -> Bool # max :: Error -> Error -> Error # min :: Error -> Error -> Error #

ParserError Text
NonRSAKey
KeyUnpackingError Text
DecryptionError Text
AWSDecryptionError Text
AWSEncryptionError Text
EncryptionError Error
MissingLine Text
UnknownParameter Text
WrongFileAction Text
CleanupError Text