Skip to content

Translate Pin Data

paymentcryptographydataplane_translate_pin_data R Documentation

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4

Description

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 a PIN block from one encryption key to another and optionally change its format. PIN block translation occurs entirely within the HSM boundary and PIN data never enters or leaves Amazon Web Services Payment Cryptography in clear text. 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 also supports use of dynamic keys and ECDH (Elliptic Curve Diffie-Hellman) based key exchange for this operation.

Dynamic keys allow you to pass a PEK as a TR-31 WrappedKeyBlock. They can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To translate PIN block using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped PEK. The incoming wrapped key shall have a key purpose of P0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.

Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block, which is translated to a PEK encrypted PIN block for use within the service. You can also use ECDH for reveal PIN, wherein the service translates the PIN block from PEK to a ECDH derived encryption key. For more information on establishing ECDH derived keys, see the Generating keys in the Amazon Web Services Payment Cryptography User Guide.

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.

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:

  • generate_pin_data

  • verify_pin_data

Usage

paymentcryptographydataplane_translate_pin_data(IncomingKeyIdentifier,
  OutgoingKeyIdentifier, IncomingTranslationAttributes,
  OutgoingTranslationAttributes, EncryptedPinBlock,
  IncomingDukptAttributes, OutgoingDukptAttributes, IncomingWrappedKey,
  OutgoingWrappedKey)

Arguments

IncomingKeyIdentifier

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

For dynamic keys, it is the keyARN of KEK of the TR-31 wrapped PEK. For ECDH, it is the keyARN of the asymmetric ECC key.

OutgoingKeyIdentifier

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

For ECDH, it is the keyARN of the asymmetric ECC key.

IncomingTranslationAttributes

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

OutgoingTranslationAttributes

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

EncryptedPinBlock

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

IncomingDukptAttributes

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

OutgoingDukptAttributes

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

IncomingWrappedKey

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

OutgoingWrappedKey

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

Value

A list with the following syntax: 

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

Request syntax

svc$translate_pin_data(
  IncomingKeyIdentifier = "string",
  OutgoingKeyIdentifier = "string",
  IncomingTranslationAttributes = list(
    IsoFormat0 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat1 = list(),
    IsoFormat3 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat4 = list(
      PrimaryAccountNumber = "string"
    )
  ),
  OutgoingTranslationAttributes = list(
    IsoFormat0 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat1 = list(),
    IsoFormat3 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat4 = list(
      PrimaryAccountNumber = "string"
    )
  ),
  EncryptedPinBlock = "string",
  IncomingDukptAttributes = list(
    KeySerialNumber = "string",
    DukptKeyDerivationType = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
    DukptKeyVariant = "BIDIRECTIONAL"|"REQUEST"|"RESPONSE"
  ),
  OutgoingDukptAttributes = list(
    KeySerialNumber = "string",
    DukptKeyDerivationType = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
    DukptKeyVariant = "BIDIRECTIONAL"|"REQUEST"|"RESPONSE"
  ),
  IncomingWrappedKey = list(
    WrappedKeyMaterial = list(
      Tr31KeyBlock = "string",
      DiffieHellmanSymmetricKey = list(
        CertificateAuthorityPublicKeyIdentifier = "string",
        PublicKeyCertificate = "string",
        KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
        KeyDerivationFunction = "NIST_SP800"|"ANSI_X963",
        KeyDerivationHashAlgorithm = "SHA_256"|"SHA_384"|"SHA_512",
        SharedInformation = "string"
      )
    ),
    KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"
  ),
  OutgoingWrappedKey = list(
    WrappedKeyMaterial = list(
      Tr31KeyBlock = "string",
      DiffieHellmanSymmetricKey = list(
        CertificateAuthorityPublicKeyIdentifier = "string",
        PublicKeyCertificate = "string",
        KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
        KeyDerivationFunction = "NIST_SP800"|"ANSI_X963",
        KeyDerivationHashAlgorithm = "SHA_256"|"SHA_384"|"SHA_512",
        SharedInformation = "string"
      )
    ),
    KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"
  )
)