Skip to content

/AWS1/IF_KMS=>DECRYPT()

About Decrypt

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

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 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.

Decrypt also supports Amazon Web Services Nitro Enclaves and NitroTPM, which provide attested environments in Amazon EC2. To call Decrypt for a Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document for the attested environment. Instead of the plaintext data, the response includes the plaintext data encrypted with the public key from the attestation document (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in 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. If you use the KeyId parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.

Required permissions: kms:Decrypt (key policy)

Related operations:

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Method Signature

METHODS /AWS1/IF_KMS~DECRYPT
  IMPORTING
    !IV_CIPHERTEXTBLOB TYPE /AWS1/KMSCIPHERTEXTTYPE OPTIONAL
    !IT_ENCRYPTIONCONTEXT TYPE /AWS1/CL_KMSENCCONTEXTTYPE_W=>TT_ENCRYPTIONCONTEXTTYPE OPTIONAL
    !IT_GRANTTOKENS TYPE /AWS1/CL_KMSGRANTTOKENLIST_W=>TT_GRANTTOKENLIST OPTIONAL
    !IV_KEYID TYPE /AWS1/KMSKEYIDTYPE OPTIONAL
    !IV_ENCRYPTIONALGORITHM TYPE /AWS1/KMSENCALGORITHMSPEC OPTIONAL
    !IO_RECIPIENT TYPE REF TO /AWS1/CL_KMSRECIPIENTINFO OPTIONAL
    !IV_DRYRUN TYPE /AWS1/KMSNULLABLEBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kmsdecryptresponse
  RAISING
    /AWS1/CX_KMSDEPENDENCYTMOUTEX
    /AWS1/CX_KMSDISABLEDEXCEPTION
    /AWS1/CX_KMSDRYRUNOPERATIONEX
    /AWS1/CX_KMSINCORRECTKEYEX
    /AWS1/CX_KMSINVCIPHERTEXTEX
    /AWS1/CX_KMSINVGRANTTOKENEX
    /AWS1/CX_KMSINVALIDKEYUSAGEEX
    /AWS1/CX_KMSKEYUNAVAILEX
    /AWS1/CX_KMSKMSINTERNALEX
    /AWS1/CX_KMSKMSINVALIDSTATEEX
    /AWS1/CX_KMSNOTFOUNDEXCEPTION
    /AWS1/CX_KMSCLIENTEXC
    /AWS1/CX_KMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ciphertextblob TYPE /AWS1/KMSCIPHERTEXTTYPE /AWS1/KMSCIPHERTEXTTYPE

Ciphertext to be decrypted. The blob includes metadata.

Optional arguments:

it_encryptioncontext TYPE /AWS1/CL_KMSENCCONTEXTTYPE_W=>TT_ENCRYPTIONCONTEXTTYPE TT_ENCRYPTIONCONTEXTTYPE

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.

it_granttokens TYPE /AWS1/CL_KMSGRANTTOKENLIST_W=>TT_GRANTTOKENLIST TT_GRANTTOKENLIST

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.

iv_keyid TYPE /AWS1/KMSKEYIDTYPE /AWS1/KMSKEYIDTYPE

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.

iv_encryptionalgorithm TYPE /AWS1/KMSENCALGORITHMSPEC /AWS1/KMSENCALGORITHMSPEC

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.

io_recipient TYPE REF TO /AWS1/CL_KMSRECIPIENTINFO /AWS1/CL_KMSRECIPIENTINFO

A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports any Amazon Web Services SDK for Amazon Web Services NitroTPM.

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 attested environment. The Plaintext field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

iv_dryrun TYPE /AWS1/KMSNULLABLEBOOLEANTYPE /AWS1/KMSNULLABLEBOOLEANTYPE

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_kmsdecryptresponse /AWS1/CL_KMSDECRYPTRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->decrypt(
  io_recipient = new /aws1/cl_kmsrecipientinfo(
    iv_attestationdocument = '5347567362473873563239796247513D'
    iv_keyencryptionalgorithm = |string|
  )
  it_encryptioncontext = VALUE /aws1/cl_kmsenccontexttype_w=>tt_encryptioncontexttype(
    (
      VALUE /aws1/cl_kmsenccontexttype_w=>ts_enccontexttype_maprow(
        value = new /aws1/cl_kmsenccontexttype_w( |string| )
        key = |string|
      )
    )
  )
  it_granttokens = VALUE /aws1/cl_kmsgranttokenlist_w=>tt_granttokenlist(
    ( new /aws1/cl_kmsgranttokenlist_w( |string| ) )
  )
  iv_ciphertextblob = '5347567362473873563239796247513D'
  iv_dryrun = ABAP_TRUE
  iv_encryptionalgorithm = |string|
  iv_keyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_keyidtype = lo_result->get_keyid( ).
  lv_plaintexttype = lo_result->get_plaintext( ).
  lv_encryptionalgorithmspec = lo_result->get_encryptionalgorithm( ).
  lv_ciphertexttype = lo_result->get_ciphertextforrecipient( ).
  lv_backingkeyidtype = lo_result->get_keymaterialid( ).
ENDIF.

To decrypt data with an asymmetric encryption KMS key

The following example decrypts data that was encrypted with an asymmetric encryption KMS key. When the KMS encryption key is asymmetric, you must specify the KMS key ID and the encryption algorithm that was used to encrypt the data.

DATA(lo_result) = lo_client->decrypt(
  iv_ciphertextblob = '3C62696E61727920646174613E'
  iv_encryptionalgorithm = |RSAES_OAEP_SHA_256|
  iv_keyid = |0987dcba-09fe-87dc-65ba-ab0987654321|
).

To decrypt data with a symmetric encryption KMS key

The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required when decrypting with a symmetric encryption key, but it is a best practice.

DATA(lo_result) = lo_client->decrypt(
  iv_ciphertextblob = '3C62696E61727920646174613E'
  iv_keyid = |arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab|
).