| Copyright | (c) 2013-2021 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 |
Amazonka.S3.Encryption.Types
Description
Synopsis
- data EncryptionError
- class AsEncryptionError r where
- _EncryptionError :: Prism' r EncryptionError
- _CipherFailure :: Prism' r CryptoError
- _PubKeyFailure :: Prism' r Error
- _IVInvalid :: Prism' r ByteString
- _EnvelopeMissing :: Prism' r (CI Text)
- _EnvelopeInvalid :: Prism' r (CI Text, String)
- _PlaintextUnavailable :: Prism' r ()
- data ContentAlgorithm = AES_CBC_PKCS5Padding
- data WrappingAlgorithm = KMSWrap
- data Location
- newtype Ext = Ext Text
- defaultExtension :: Ext
- appendExtension :: Ext -> ObjectKey -> ObjectKey
- newtype Description = Description {}
- data Key
- description :: Lens' Key Description
Documentation
data EncryptionError Source #
An error thrown when performing encryption or decryption.
Constructors
| CipherFailure CryptoError | Error initialising an AES cipher from a secret key. |
| PubKeyFailure Error | Failure performing asymmetric encryption/decryption. |
| IVInvalid ByteString | Failure creating an IV from some bytes. |
| EnvelopeMissing (CI Text) | Required envelope field missing. |
| EnvelopeInvalid (CI Text) String | Error parsing envelope. |
| PlaintextUnavailable | KMS error when retrieving decrypted plaintext. |
Instances
| Eq EncryptionError Source # | |
Defined in Amazonka.S3.Encryption.Types Methods (==) :: EncryptionError -> EncryptionError -> Bool # (/=) :: EncryptionError -> EncryptionError -> Bool # | |
| Show EncryptionError Source # | |
Defined in Amazonka.S3.Encryption.Types Methods showsPrec :: Int -> EncryptionError -> ShowS # show :: EncryptionError -> String # showList :: [EncryptionError] -> ShowS # | |
| Exception EncryptionError Source # | |
Defined in Amazonka.S3.Encryption.Types Methods toException :: EncryptionError -> SomeException # | |
| AsEncryptionError EncryptionError Source # | |
Defined in Amazonka.S3.Encryption.Types Methods _EncryptionError :: Prism' EncryptionError EncryptionError Source # _CipherFailure :: Prism' EncryptionError CryptoError Source # _PubKeyFailure :: Prism' EncryptionError Error Source # _IVInvalid :: Prism' EncryptionError ByteString Source # _EnvelopeMissing :: Prism' EncryptionError (CI Text) Source # _EnvelopeInvalid :: Prism' EncryptionError (CI Text, String) Source # | |
class AsEncryptionError r where Source #
Minimal complete definition
Methods
_EncryptionError :: Prism' r EncryptionError Source #
_CipherFailure :: Prism' r CryptoError Source #
_PubKeyFailure :: Prism' r Error Source #
_IVInvalid :: Prism' r ByteString Source #
_EnvelopeMissing :: Prism' r (CI Text) Source #
_EnvelopeInvalid :: Prism' r (CI Text, String) Source #
_PlaintextUnavailable :: Prism' r () Source #
Instances
data ContentAlgorithm Source #
Constructors
| AES_CBC_PKCS5Padding | AESCBCPKCS5Padding |
Instances
| ToByteString ContentAlgorithm Source # | |
Defined in Amazonka.S3.Encryption.Types Methods toBS :: ContentAlgorithm -> ByteString # | |
| FromText ContentAlgorithm Source # | |
Defined in Amazonka.S3.Encryption.Types | |
data WrappingAlgorithm Source #
Constructors
| KMSWrap | Key Management Service. |
Instances
| ToByteString WrappingAlgorithm Source # | |
Defined in Amazonka.S3.Encryption.Types Methods toBS :: WrappingAlgorithm -> ByteString # | |
| FromText WrappingAlgorithm Source # | |
Defined in Amazonka.S3.Encryption.Types | |
An instructions file extension.
defaultExtension :: Ext Source #
Defaults to .instruction
newtype Description Source #
A key material description. This is attached in plaintext to the metadata, and will be logged using CloudTrail. For KMS decryption any supplemental material description is merged with the description stored on the object during decryption.
Constructors
| Description | |
Fields | |
Instances
The key used for encryption and decryption.
Constructors
| Symmetric AES256 Description | |
| Asymmetric KeyPair Description | |
| KMS Text Description |
description :: Lens' Key Description Source #
Modify the material description of a key.
See: Description.