Class: Aws::KMS::Types::DecryptRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::DecryptRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#ciphertext_blob ⇒ String
Ciphertext to be decrypted.
-
#dry_run ⇒ Boolean
Checks if your request will succeed.
-
#encryption_algorithm ⇒ String
Specifies the encryption algorithm that will be used to decrypt the ciphertext.
-
#encryption_context ⇒ Hash<String,String>
Specifies the encryption context to use when decrypting the data.
-
#grant_tokens ⇒ Array<String>
A list of grant tokens.
-
#key_id ⇒ String
Specifies the KMS key that KMS uses to decrypt the ciphertext.
-
#recipient ⇒ Types::RecipientInfo
A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave’s public key.
Instance Attribute Details
#ciphertext_blob ⇒ String
Ciphertext to be decrypted. The blob includes metadata.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
Checks if your request will succeed. ‘DryRun` is an optional parameter.
To learn more about how to use this parameter, see [Testing your KMS API calls] in the *Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#encryption_algorithm ⇒ String
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.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#encryption_context ⇒ Hash<String,String>
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*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#grant_tokens ⇒ Array<String>
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*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#key_id ⇒ String
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.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |
#recipient ⇒ Types::RecipientInfo
A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave’s public key. The only valid encryption algorithm is ‘RSAES_OAEP_SHA_256`.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK] or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the ‘CiphertextForRecipient` field in the response. This ciphertext can be decrypted only with the private key in the enclave. The `Plaintext` field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS] in the *Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc [2]: docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk [3]: docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/aws-sdk-kms/types.rb', line 1635 class DecryptRequest < Struct.new( :ciphertext_blob, :encryption_context, :grant_tokens, :key_id, :encryption_algorithm, :recipient, :dry_run) SENSITIVE = [] include Aws::Structure end |