Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Credentials.Types

Description

Synopsis

Documentation

newtype KeyId Source #

The KMS master key identifier.

Constructors

KeyId Text

Instances

Eq KeyId Source #
Methods (==) :: KeyId -> KeyId -> Bool # (/=) :: KeyId -> KeyId -> Bool #
Ord KeyId Source #
Methods compare :: KeyId -> KeyId -> Ordering # (<) :: KeyId -> KeyId -> Bool # (<=) :: KeyId -> KeyId -> Bool # (>) :: KeyId -> KeyId -> Bool # (>=) :: KeyId -> KeyId -> Bool # max :: KeyId -> KeyId -> KeyId # min :: KeyId -> KeyId -> KeyId #
Show KeyId Source #
Methods showsPrec :: Int -> KeyId -> ShowS # show :: KeyId -> String # showList :: [KeyId] -> ShowS #
ToText KeyId Source #
Methods toText :: KeyId -> Text #
FromText KeyId Source #
Methods parser :: Parser KeyId #
ToByteString KeyId Source #
Methods toBS :: KeyId -> ByteString #
ToLog KeyId Source #
Methods build :: KeyId -> Builder #

defaultKeyId :: KeyId Source #

The default KMS master key alias.

Value: alias/credentials

newtype Name Source #

A shared/readable name for a secret.

Constructors

Name Text

Instances

Eq Name Source #
Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
Show Name Source #
Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
ToText Name Source #
Methods toText :: Name -> Text #
FromText Name Source #
Methods parser :: Parser Name #
ToByteString Name Source #
Methods toBS :: Name -> ByteString #
ToLog Name Source #
Methods build :: Name -> Builder #
Attribute Name Source #
Methods toAttr :: Name -> AttributeValue Source # parseAttr :: AttributeValue -> Maybe Name Source #
Item Name Source #
Methods toItem :: Name -> HashMap Text AttributeValue Source # parseItem :: HashMap Text AttributeValue -> Either CredentialError Name Source #

newtype Revision Source #

An opaque, non-monotonic revision number.

Constructors

Revision ByteString

Instances

Eq Revision Source #
Methods (==) :: Revision -> Revision -> Bool # (/=) :: Revision -> Revision -> Bool #
Ord Revision Source #
Methods compare :: Revision -> Revision -> Ordering # (<) :: Revision -> Revision -> Bool # (<=) :: Revision -> Revision -> Bool # (>) :: Revision -> Revision -> Bool # (>=) :: Revision -> Revision -> Bool # max :: Revision -> Revision -> Revision # min :: Revision -> Revision -> Revision #
Show Revision Source #
Methods showsPrec :: Int -> Revision -> ShowS # show :: Revision -> String # showList :: [Revision] -> ShowS #
ToText Revision Source #
Methods toText :: Revision -> Text #
FromText Revision Source #
Methods parser :: Parser Revision #
ToByteString Revision Source #
Methods toBS :: Revision -> ByteString #
ToLog Revision Source #
Methods build :: Revision -> Builder #
Attribute Revision Source #
Methods toAttr :: Revision -> AttributeValue Source # parseAttr :: AttributeValue -> Maybe Revision Source #
Item Revision Source #
Methods toItem :: Revision -> HashMap Text AttributeValue Source # parseItem :: HashMap Text AttributeValue -> Either CredentialError Revision Source #

newtype Context Source #

A KMS encryption context.

See: KMS Encryption Context documentation for more information.

Constructors

Context
Fields fromContext :: HashMap Text Text

Instances

Eq Context Source #
Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #
Show Context Source #
Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Monoid Context Source #
Methods mempty :: Context # mappend :: Context -> Context -> Context # mconcat :: [Context] -> Context #

data Encrypted Source #

The encryption parameters required to perform decryption.

Constructors

Encrypted
Fields wrappedKey :: !ByteString The wrapped (encrypted) data encryption key. ciphertext :: !ByteString The encrypted ciphertext. digest :: !(HMAC SHA256) HMAC SHA256 digest of the ciphertext.

Instances

Item Encrypted Source #
Methods toItem :: Encrypted -> HashMap Text AttributeValue Source # parseItem :: HashMap Text AttributeValue -> Either CredentialError Encrypted Source #

data Setup Source #

Denotes idempotency of an action. That is, whether an action resulted in any setup being performed.

Constructors

Created
Exists

Instances

Eq Setup Source #
Methods (==) :: Setup -> Setup -> Bool # (/=) :: Setup -> Setup -> Bool #
Show Setup Source #
Methods showsPrec :: Int -> Setup -> ShowS # show :: Setup -> String # showList :: [Setup] -> ShowS #
ToText Setup Source #
Methods toText :: Setup -> Text #
ToLog Setup Source #
Methods build :: Setup -> Builder #

data CredentialError Source #

Constructors

MasterKeyMissing KeyId (Maybe Text)	The specified master key id doesn't exist.
IntegrityFailure Name ByteString ByteString	The computed HMAC doesn't matched the stored HMAC.
EncryptFailure Context Name Text	Failure occured during local encryption.
DecryptFailure Context Name Text	Failure occured during local decryption.
StorageMissing Text	Storage doesn't exist, or has gone on holiday.
StorageFailure Text	Some storage pre-condition wasn't met. For example: DynamoDB column size exceeded.
FieldMissing Text [Text]	Missing field from the storage engine.
FieldInvalid Text String	Unable to parse field from the storage engine.
SecretMissing Name (Maybe Revision) Text	Secret with the specified name cannot found.
OptimisticLockFailure Name Revision Text	Attempting to insert a revision that already exists.

Instances

Eq CredentialError Source #
Methods (==) :: CredentialError -> CredentialError -> Bool # (/=) :: CredentialError -> CredentialError -> Bool #
Show CredentialError Source #
Methods showsPrec :: Int -> CredentialError -> ShowS # show :: CredentialError -> String # showList :: [CredentialError] -> ShowS #
Exception CredentialError Source #
Methods toException :: CredentialError -> SomeException # fromException :: SomeException -> Maybe CredentialError # displayException :: CredentialError -> String #
AsCredentialError CredentialError Source #
Methods _CredentialError :: Prism' CredentialError CredentialError Source # _MasterKeyMissing :: Prism' CredentialError (KeyId, Maybe Text) Source # _IntegrityFailure :: Prism' CredentialError (Name, ByteString, ByteString) Source # _EncryptFailure :: Prism' CredentialError (Context, Name, Text) Source # _DecryptFailure :: Prism' CredentialError (Context, Name, Text) Source # _StorageMissing :: Prism' CredentialError Text Source # _StorageFailure :: Prism' CredentialError Text Source # _FieldMissing :: Prism' CredentialError (Text, [Text]) Source # _FieldInvalid :: Prism' CredentialError (Text, String) Source # _SecretMissing :: Prism' CredentialError (Name, Maybe Revision, Text) Source # _OptimisticLockFailure :: Prism' CredentialError (Name, Revision, Text) Source #

class AsCredentialError a where Source #

Methods

_CredentialError :: Prism' a CredentialError Source #

_MasterKeyMissing :: Prism' a (KeyId, Maybe Text) Source #

_IntegrityFailure :: Prism' a (Name, ByteString, ByteString) Source #

_EncryptFailure :: Prism' a (Context, Name, Text) Source #

_DecryptFailure :: Prism' a (Context, Name, Text) Source #

_StorageMissing :: Prism' a Text Source #

_StorageFailure :: Prism' a Text Source #

_FieldMissing :: Prism' a (Text, [Text]) Source #

_FieldInvalid :: Prism' a (Text, String) Source #

_SecretMissing :: Prism' a (Name, Maybe Revision, Text) Source #

_OptimisticLockFailure :: Prism' a (Name, Revision, Text) Source #

Instances

AsCredentialError SomeException Source #
Methods _CredentialError :: Prism' SomeException CredentialError Source # _MasterKeyMissing :: Prism' SomeException (KeyId, Maybe Text) Source # _IntegrityFailure :: Prism' SomeException (Name, ByteString, ByteString) Source # _EncryptFailure :: Prism' SomeException (Context, Name, Text) Source # _DecryptFailure :: Prism' SomeException (Context, Name, Text) Source # _StorageMissing :: Prism' SomeException Text Source # _StorageFailure :: Prism' SomeException Text Source # _FieldMissing :: Prism' SomeException (Text, [Text]) Source # _FieldInvalid :: Prism' SomeException (Text, String) Source # _SecretMissing :: Prism' SomeException (Name, Maybe Revision, Text) Source # _OptimisticLockFailure :: Prism' SomeException (Name, Revision, Text) Source #
AsCredentialError CredentialError Source #
Methods _CredentialError :: Prism' CredentialError CredentialError Source # _MasterKeyMissing :: Prism' CredentialError (KeyId, Maybe Text) Source # _IntegrityFailure :: Prism' CredentialError (Name, ByteString, ByteString) Source # _EncryptFailure :: Prism' CredentialError (Context, Name, Text) Source # _DecryptFailure :: Prism' CredentialError (Context, Name, Text) Source # _StorageMissing :: Prism' CredentialError Text Source # _StorageFailure :: Prism' CredentialError Text Source # _FieldMissing :: Prism' CredentialError (Text, [Text]) Source # _FieldInvalid :: Prism' CredentialError (Text, String) Source # _SecretMissing :: Prism' CredentialError (Name, Maybe Revision, Text) Source # _OptimisticLockFailure :: Prism' CredentialError (Name, Revision, Text) Source #