Amazonka.KMS.Decrypt

Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:

• Encrypt
• GenerateDataKey
• GenerateDataKeyPair
• GenerateDataKeyWithoutPlaintext
• GenerateDataKeyPairWithoutPlaintext

You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.

If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:Decrypt (key policy)

Related operations:

• Encrypt
• GenerateDataKey
• GenerateDataKeyPair
• ReEncrypt

Creating a Request

data Decrypt

See: newDecrypt smart constructor.

Constructors

Decrypt'

Fields

• encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec

  Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

  This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

• encryptionContext :: Maybe (HashMap Text Text)

  Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

  An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

  For more information, see Encryption context in the Key Management Service Developer Guide.

• grantTokens :: Maybe [Text]

  A list of grant tokens.

  Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

• keyId :: Maybe Text

  Specifies the KMS key that KMS uses to decrypt the ciphertext.

  Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

  This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

  To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

  For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

  To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

• ciphertextBlob :: Base64

  Ciphertext to be decrypted. The blob includes metadata.

Instances

ToJSON Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toJSON :: Decrypt -> Value

toEncoding :: Decrypt -> Encoding

toJSONList :: [Decrypt] -> Value

toEncodingList :: [Decrypt] -> Encoding

ToHeaders Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toHeaders :: Decrypt -> [Header]

ToPath Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toPath :: Decrypt -> ByteString

ToQuery Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toQuery :: Decrypt -> QueryString

AWSRequest Decrypt

Defined in Amazonka.KMS.Decrypt

Associated Types

type AWSResponse Decrypt

Methods

request :: (Service -> Service) -> Decrypt -> Request Decrypt

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Decrypt -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Decrypt)))

Generic Decrypt

Defined in Amazonka.KMS.Decrypt

Associated Types

type Rep Decrypt :: Type -> Type

Methods

from :: Decrypt -> Rep Decrypt x

to :: Rep Decrypt x -> Decrypt

Read Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

readsPrec :: Int -> ReadS Decrypt

readList :: ReadS [Decrypt]

readPrec :: ReadPrec Decrypt

readListPrec :: ReadPrec [Decrypt]

Show Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

showsPrec :: Int -> Decrypt -> ShowS

show :: Decrypt -> String

showList :: [Decrypt] -> ShowS

NFData Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

rnf :: Decrypt -> ()

Eq Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

(==) :: Decrypt -> Decrypt -> Bool

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

Hashable Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

hashWithSalt :: Int -> Decrypt -> Int

hash :: Decrypt -> Int

type AWSResponse Decrypt

Defined in Amazonka.KMS.Decrypt

type AWSResponse Decrypt = DecryptResponse

type Rep Decrypt

Defined in Amazonka.KMS.Decrypt

type Rep Decrypt = D1 ('MetaData "Decrypt" "Amazonka.KMS.Decrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Decrypt'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))))

newDecrypt

Arguments

:: ByteString

$sel:ciphertextBlob:Decrypt'

-> Decrypt

Create a value of Decrypt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Decrypt, decrypt_encryptionAlgorithm - Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

$sel:encryptionContext:Decrypt', decrypt_encryptionContext - Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:Decrypt', decrypt_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Decrypt, decrypt_keyId - Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:ciphertextBlob:Decrypt', decrypt_ciphertextBlob - Ciphertext to be decrypted. The blob includes metadata.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Request Lenses

decrypt_encryptionAlgorithm :: Lens' Decrypt (Maybe EncryptionAlgorithmSpec)

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

decrypt_encryptionContext :: Lens' Decrypt (Maybe (HashMap Text Text))

Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

decrypt_grantTokens :: Lens' Decrypt (Maybe [Text])

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

decrypt_keyId :: Lens' Decrypt (Maybe Text)

Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

decrypt_ciphertextBlob :: Lens' Decrypt ByteString

Ciphertext to be decrypted. The blob includes metadata.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Destructuring the Response

data DecryptResponse

See: newDecryptResponse smart constructor.

Constructors

DecryptResponse'

Fields

• encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec

  The encryption algorithm that was used to decrypt the ciphertext.

• keyId :: Maybe Text

  The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

• plaintext :: Maybe (Sensitive Base64)

  Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DecryptResponse

Defined in Amazonka.KMS.Decrypt

Associated Types

type Rep DecryptResponse :: Type -> Type

Methods

from :: DecryptResponse -> Rep DecryptResponse x

to :: Rep DecryptResponse x -> DecryptResponse

Show DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

showsPrec :: Int -> DecryptResponse -> ShowS

show :: DecryptResponse -> String

showList :: [DecryptResponse] -> ShowS

NFData DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

rnf :: DecryptResponse -> ()

Eq DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

(==) :: DecryptResponse -> DecryptResponse -> Bool

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

type Rep DecryptResponse

Defined in Amazonka.KMS.Decrypt

type Rep DecryptResponse = D1 ('MetaData "DecryptResponse" "Amazonka.KMS.Decrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DecryptResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "plaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDecryptResponse

Arguments

:: Int

$sel:httpStatus:DecryptResponse'

-> DecryptResponse

Create a value of DecryptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Decrypt, decryptResponse_encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Decrypt, decryptResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

$sel:plaintext:DecryptResponse', decryptResponse_plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:httpStatus:DecryptResponse', decryptResponse_httpStatus - The response's http status code.

Response Lenses

decryptResponse_encryptionAlgorithm :: Lens' DecryptResponse (Maybe EncryptionAlgorithmSpec)

The encryption algorithm that was used to decrypt the ciphertext.

decryptResponse_keyId :: Lens' DecryptResponse (Maybe Text)

The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

decryptResponse_plaintext :: Lens' DecryptResponse (Maybe ByteString)

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

decryptResponse_httpStatus :: Lens' DecryptResponse Int

The response's http status code.