Payment Cryptography Data Plane

2024/07/01 - Payment Cryptography Data Plane - 4 updated api methods

Changes  Adding support for dynamic keys for encrypt, decrypt, re-encrypt and translate pin functions. With this change, customers can use one-time TR-31 keys directly in dataplane operations without the need to first import them into the service.

DecryptData (updated) Link ¶
Changes (request) 
{'WrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}}}

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:

See also: AWS API Documentation

Request Syntax

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

string

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

type CipherText

string

param CipherText

[REQUIRED]

The ciphertext to decrypt.

type DecryptionAttributes

dict

param DecryptionAttributes

[REQUIRED]

The encryption key type and attributes for ciphertext decryption.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Symmetric, Asymmetric, Dukpt, Emv.

  • Symmetric (dict) --

    Parameters that are required to perform encryption and decryption using symmetric keys.

    • Mode (string) -- [REQUIRED]

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

    • PaddingType (string) --

      The padding to be included with the data.

  • Asymmetric (dict) --

    Parameters for plaintext encryption using asymmetric keys.

    • PaddingType (string) --

      The padding to be included with the data.

  • Dukpt (dict) --

    Parameters that are required to encrypt plaintext data using DUKPT.

    • KeySerialNumber (string) -- [REQUIRED]

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • Mode (string) --

      The block cipher method to use for encryption.

      The default is CBC.

    • DukptKeyDerivationType (string) --

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

    • DukptKeyVariant (string) --

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

  • Emv (dict) --

    Parameters for plaintext encryption using EMV keys.

    • MajorKeyDerivationMode (string) -- [REQUIRED]

      The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • PanSequenceNumber (string) -- [REQUIRED]

      A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

    • SessionDerivationData (string) -- [REQUIRED]

      The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.

    • Mode (string) --

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

type WrappedKey

dict

param WrappedKey

The WrappedKeyBlock containing the encryption key for ciphertext decryption.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

rtype

dict

returns

Response Syntax

{
    'KeyArn': 'string',
    'KeyCheckValue': 'string',
    'PlainText': 'string'
}

Response Structure

  • (dict) --

    • KeyArn (string) --

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

    • KeyCheckValue (string) --

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • PlainText (string) --

      The decrypted plaintext data in hexBinary format.

EncryptData (updated) Link ¶
Changes (request) 
{'WrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}}}

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

You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt . In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey.

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

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

To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey , or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey .

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:

See also: AWS API Documentation

Request Syntax

client.encrypt_data(
    KeyIdentifier='string',
    PlainText='string',
    EncryptionAttributes={
        'Symmetric': {
            'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
            'InitializationVector': 'string',
            'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
        },
        'Asymmetric': {
            'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
        },
        'Dukpt': {
            'KeySerialNumber': 'string',
            'Mode': 'ECB'|'CBC',
            'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
            'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
            'InitializationVector': 'string'
        },
        'Emv': {
            'MajorKeyDerivationMode': 'EMV_OPTION_A'|'EMV_OPTION_B',
            'PrimaryAccountNumber': 'string',
            'PanSequenceNumber': 'string',
            'SessionDerivationData': 'string',
            'Mode': 'ECB'|'CBC',
            'InitializationVector': 'string'
        }
    },
    WrappedKey={
        'WrappedKeyMaterial': {
            'Tr31KeyBlock': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    }
)
type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

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.

type PlainText

string

param PlainText

[REQUIRED]

The plaintext to be encrypted.

Note

For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes . For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide .

type EncryptionAttributes

dict

param EncryptionAttributes

[REQUIRED]

The encryption key type and attributes for plaintext encryption.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Symmetric, Asymmetric, Dukpt, Emv.

  • Symmetric (dict) --

    Parameters that are required to perform encryption and decryption using symmetric keys.

    • Mode (string) -- [REQUIRED]

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

    • PaddingType (string) --

      The padding to be included with the data.

  • Asymmetric (dict) --

    Parameters for plaintext encryption using asymmetric keys.

    • PaddingType (string) --

      The padding to be included with the data.

  • Dukpt (dict) --

    Parameters that are required to encrypt plaintext data using DUKPT.

    • KeySerialNumber (string) -- [REQUIRED]

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • Mode (string) --

      The block cipher method to use for encryption.

      The default is CBC.

    • DukptKeyDerivationType (string) --

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

    • DukptKeyVariant (string) --

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

  • Emv (dict) --

    Parameters for plaintext encryption using EMV keys.

    • MajorKeyDerivationMode (string) -- [REQUIRED]

      The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • PanSequenceNumber (string) -- [REQUIRED]

      A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

    • SessionDerivationData (string) -- [REQUIRED]

      The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.

    • Mode (string) --

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

type WrappedKey

dict

param WrappedKey

The WrappedKeyBlock containing the encryption key for plaintext encryption.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

rtype

dict

returns

Response Syntax

{
    'KeyArn': 'string',
    'KeyCheckValue': 'string',
    'CipherText': 'string'
}

Response Structure

  • (dict) --

    • KeyArn (string) --

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

    • KeyCheckValue (string) --

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • CipherText (string) --

      The encrypted ciphertext.

ReEncryptData (updated) Link ¶
Changes (request) 
{'IncomingWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                        'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}},
 'OutgoingWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                        'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}}}

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.

You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt .

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.

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:

See also: AWS API Documentation

Request Syntax

client.re_encrypt_data(
    IncomingKeyIdentifier='string',
    OutgoingKeyIdentifier='string',
    CipherText='string',
    IncomingEncryptionAttributes={
        'Symmetric': {
            'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
            'InitializationVector': 'string',
            'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
        },
        'Dukpt': {
            'KeySerialNumber': 'string',
            'Mode': 'ECB'|'CBC',
            'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
            'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
            'InitializationVector': 'string'
        }
    },
    OutgoingEncryptionAttributes={
        'Symmetric': {
            'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
            'InitializationVector': 'string',
            'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
        },
        'Dukpt': {
            'KeySerialNumber': 'string',
            'Mode': 'ECB'|'CBC',
            'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
            'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
            'InitializationVector': 'string'
        }
    },
    IncomingWrappedKey={
        'WrappedKeyMaterial': {
            'Tr31KeyBlock': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    },
    OutgoingWrappedKey={
        'WrappedKeyMaterial': {
            'Tr31KeyBlock': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    }
)
type IncomingKeyIdentifier

string

param IncomingKeyIdentifier

[REQUIRED]

The keyARN of the encryption key of incoming ciphertext data.

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.

type OutgoingKeyIdentifier

string

param OutgoingKeyIdentifier

[REQUIRED]

The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

type CipherText

string

param CipherText

[REQUIRED]

Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.

type IncomingEncryptionAttributes

dict

param IncomingEncryptionAttributes

[REQUIRED]

The attributes and values for incoming ciphertext.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Symmetric, Dukpt.

  • Symmetric (dict) --

    Parameters that are required to encrypt data using symmetric keys.

    • Mode (string) -- [REQUIRED]

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

    • PaddingType (string) --

      The padding to be included with the data.

  • Dukpt (dict) --

    Parameters that are required to encrypt plaintext data using DUKPT.

    • KeySerialNumber (string) -- [REQUIRED]

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • Mode (string) --

      The block cipher method to use for encryption.

      The default is CBC.

    • DukptKeyDerivationType (string) --

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

    • DukptKeyVariant (string) --

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

type OutgoingEncryptionAttributes

dict

param OutgoingEncryptionAttributes

[REQUIRED]

The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Symmetric, Dukpt.

  • Symmetric (dict) --

    Parameters that are required to encrypt data using symmetric keys.

    • Mode (string) -- [REQUIRED]

      The block cipher method to use for encryption.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

    • PaddingType (string) --

      The padding to be included with the data.

  • Dukpt (dict) --

    Parameters that are required to encrypt plaintext data using DUKPT.

    • KeySerialNumber (string) -- [REQUIRED]

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • Mode (string) --

      The block cipher method to use for encryption.

      The default is CBC.

    • DukptKeyDerivationType (string) --

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

    • DukptKeyVariant (string) --

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

    • InitializationVector (string) --

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

type IncomingWrappedKey

dict

param IncomingWrappedKey

The WrappedKeyBlock containing the encryption key of incoming ciphertext data.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

type OutgoingWrappedKey

dict

param OutgoingWrappedKey

The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

rtype

dict

returns

Response Syntax

{
    'KeyArn': 'string',
    'KeyCheckValue': 'string',
    'CipherText': 'string'
}

Response Structure

  • (dict) --

    • KeyArn (string) --

      The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

    • KeyCheckValue (string) --

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • CipherText (string) --

      The encrypted ciphertext.

TranslatePinData (updated) Link ¶
Changes (request) 
{'IncomingWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                        'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}},
 'OutgoingWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
                        'WrappedKeyMaterial': {'Tr31KeyBlock': 'string'}}}

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide .

PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.

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 .

Note

Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

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

Related operations:

  • GeneratePinData

  • VerifyPinData

See also: AWS API Documentation

Request Syntax

client.translate_pin_data(
    IncomingKeyIdentifier='string',
    OutgoingKeyIdentifier='string',
    IncomingTranslationAttributes={
        'IsoFormat0': {
            'PrimaryAccountNumber': 'string'
        },
        'IsoFormat1': {}
        ,
        'IsoFormat3': {
            'PrimaryAccountNumber': 'string'
        },
        'IsoFormat4': {
            'PrimaryAccountNumber': 'string'
        }
    },
    OutgoingTranslationAttributes={
        'IsoFormat0': {
            'PrimaryAccountNumber': 'string'
        },
        'IsoFormat1': {}
        ,
        'IsoFormat3': {
            'PrimaryAccountNumber': 'string'
        },
        'IsoFormat4': {
            'PrimaryAccountNumber': 'string'
        }
    },
    EncryptedPinBlock='string',
    IncomingDukptAttributes={
        'KeySerialNumber': 'string',
        'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
        'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE'
    },
    OutgoingDukptAttributes={
        'KeySerialNumber': 'string',
        'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
        'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE'
    },
    IncomingWrappedKey={
        'WrappedKeyMaterial': {
            'Tr31KeyBlock': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    },
    OutgoingWrappedKey={
        'WrappedKeyMaterial': {
            'Tr31KeyBlock': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    }
)
type IncomingKeyIdentifier

string

param IncomingKeyIdentifier

[REQUIRED]

The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.

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

type OutgoingKeyIdentifier

string

param OutgoingKeyIdentifier

[REQUIRED]

The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.

type IncomingTranslationAttributes

dict

param IncomingTranslationAttributes

[REQUIRED]

The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: IsoFormat0, IsoFormat1, IsoFormat3, IsoFormat4.

  • IsoFormat0 (dict) --

    Parameters that are required for ISO9564 PIN format 0 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • IsoFormat1 (dict) --

    Parameters that are required for ISO9564 PIN format 1 tranlation.

  • IsoFormat3 (dict) --

    Parameters that are required for ISO9564 PIN format 3 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • IsoFormat4 (dict) --

    Parameters that are required for ISO9564 PIN format 4 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

type OutgoingTranslationAttributes

dict

param OutgoingTranslationAttributes

[REQUIRED]

The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: IsoFormat0, IsoFormat1, IsoFormat3, IsoFormat4.

  • IsoFormat0 (dict) --

    Parameters that are required for ISO9564 PIN format 0 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • IsoFormat1 (dict) --

    Parameters that are required for ISO9564 PIN format 1 tranlation.

  • IsoFormat3 (dict) --

    Parameters that are required for ISO9564 PIN format 3 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • IsoFormat4 (dict) --

    Parameters that are required for ISO9564 PIN format 4 tranlation.

    • PrimaryAccountNumber (string) -- [REQUIRED]

      The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

type EncryptedPinBlock

string

param EncryptedPinBlock

[REQUIRED]

The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.

type IncomingDukptAttributes

dict

param IncomingDukptAttributes

The attributes and values to use for incoming DUKPT encryption key for PIN block translation.

  • KeySerialNumber (string) -- [REQUIRED]

    The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

  • DukptKeyDerivationType (string) --

    The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

  • DukptKeyVariant (string) --

    The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.

type OutgoingDukptAttributes

dict

param OutgoingDukptAttributes

The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.

  • KeySerialNumber (string) -- [REQUIRED]

    The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

  • DukptKeyDerivationType (string) --

    The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

  • DukptKeyVariant (string) --

    The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.

type IncomingWrappedKey

dict

param IncomingWrappedKey

The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

type OutgoingWrappedKey

dict

param OutgoingWrappedKey

The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.

  • WrappedKeyMaterial (dict) -- [REQUIRED]

    Parameter information of a WrappedKeyBlock for encryption key exchange.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

    • Tr31KeyBlock (string) --

      The TR-31 wrapped key block.

  • KeyCheckValueAlgorithm (string) --

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

rtype

dict

returns

Response Syntax

{
    'PinBlock': 'string',
    'KeyArn': 'string',
    'KeyCheckValue': 'string'
}

Response Structure

  • (dict) --

    • PinBlock (string) --

      The outgoing encrypted PIN block data after translation.

    • KeyArn (string) --

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.

    • KeyCheckValue (string) --

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.