Decrypt Data

paymentcryptographydataplane_decrypt_data

R Documentation

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme¶

Description¶

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.

You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.

For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

Usage¶

paymentcryptographydataplane_decrypt_data(KeyIdentifier, CipherText,
  DecryptionAttributes, WrappedKey)

Arguments¶

KeyIdentifier

[required] The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.

When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

CipherText

[required] The ciphertext to decrypt.

DecryptionAttributes

[required] The encryption key type and attributes for ciphertext decryption.

WrappedKey

The WrappedKeyBlock containing the encryption key for ciphertext decryption.

Value¶

A list with the following syntax:

list(
  KeyArn = "string",
  KeyCheckValue = "string",
  PlainText = "string"
)

Request syntax¶

svc$decrypt_data(
  KeyIdentifier = "string",
  CipherText = "string",
  DecryptionAttributes = list(
    Symmetric = list(
      Mode = "ECB"|"CBC"|"CFB"|"CFB1"|"CFB8"|"CFB64"|"CFB128"|"OFB",
      InitializationVector = "string",
      PaddingType = "PKCS1"|"OAEP_SHA1"|"OAEP_SHA256"|"OAEP_SHA512"
    ),
    Asymmetric = list(
      PaddingType = "PKCS1"|"OAEP_SHA1"|"OAEP_SHA256"|"OAEP_SHA512"
    ),
    Dukpt = list(
      KeySerialNumber = "string",
      Mode = "ECB"|"CBC",
      DukptKeyDerivationType = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
      DukptKeyVariant = "BIDIRECTIONAL"|"REQUEST"|"RESPONSE",
      InitializationVector = "string"
    ),
    Emv = list(
      MajorKeyDerivationMode = "EMV_OPTION_A"|"EMV_OPTION_B",
      PrimaryAccountNumber = "string",
      PanSequenceNumber = "string",
      SessionDerivationData = "string",
      Mode = "ECB"|"CBC",
      InitializationVector = "string"
    )
  ),
  WrappedKey = list(
    WrappedKeyMaterial = list(
      Tr31KeyBlock = "string"
    ),
    KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"
  )
)