2024/10/23 - Payment Cryptography Data Plane - 6 updated api methods
Changes Add support for ECC P-256 and P-384 Keys.
{'WrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': '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 decryption key generated within Amazon Web Services Payment Cryptography, or you can import your own decryption 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.
This operation also supports dynamic keys, allowing you to pass a dynamic decryption key as a TR-31 WrappedKeyBlock. This 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 decrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped decryption key material. The incoming wrapped key shall have a key purpose of D0 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.
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:
EncryptData
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',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[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.
string
[REQUIRED]
The ciphertext to decrypt.
dict
[REQUIRED]
The encryption key type and attributes for ciphertext decryption.
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). Typically 00 is used, if no value is provided by the terminal.
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.
dict
The WrappedKeyBlock containing the encryption key for ciphertext decryption.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
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.
{'WrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': '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.
This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This 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 encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 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.
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:
DecryptData
ReEncryptData
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',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[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.
string
[REQUIRED]
The plaintext to be encrypted.
dict
[REQUIRED]
The encryption key type and attributes for plaintext encryption.
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). Typically 00 is used, if no value is provided by the terminal.
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.
dict
The WrappedKeyBlock containing the encryption key for plaintext encryption.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
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.
{'EncryptionWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': 'string'},
'Tr31KeyBlock': 'string'}},
'PinBlockFormat': {'ISO_FORMAT_4'}}
Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide.
PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation.
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. You can also use it for reveal PIN, wherein the generated PIN block is protected by the ECDH derived key before transmission from Amazon Web Services Payment Cryptography. For more information on establishing ECDH derived keys, see the Generating keys in the Amazon Web Services Payment Cryptography User Guide.
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:
GenerateCardValidationData
TranslatePinData
VerifyPinData
See also: AWS API Documentation
Request Syntax
client.generate_pin_data(
GenerationKeyIdentifier='string',
EncryptionKeyIdentifier='string',
GenerationAttributes={
'VisaPin': {
'PinVerificationKeyIndex': 123
},
'VisaPinVerificationValue': {
'EncryptedPinBlock': 'string',
'PinVerificationKeyIndex': 123
},
'Ibm3624PinOffset': {
'EncryptedPinBlock': 'string',
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624NaturalPin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624RandomPin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624PinFromOffset': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string',
'PinOffset': 'string'
}
},
PinDataLength=123,
PrimaryAccountNumber='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_3'|'ISO_FORMAT_4',
EncryptionWrappedKey={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[REQUIRED]
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
string
[REQUIRED]
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.
dict
[REQUIRED]
The attributes and values to use for PIN, PVV, or PIN Offset generation.
VisaPin (dict) --
Parameters that are required to generate or verify Visa PIN.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
VisaPinVerificationValue (dict) --
Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
EncryptedPinBlock (string) -- [REQUIRED]
The encrypted PIN block data to verify.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
Ibm3624PinOffset (dict) --
Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
EncryptedPinBlock (string) -- [REQUIRED]
The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).
DecimalizationTable (string) -- [REQUIRED]
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624NaturalPin (dict) --
Parameters that are required to generate or verify Ibm3624 natural PIN.
DecimalizationTable (string) -- [REQUIRED]
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624RandomPin (dict) --
Parameters that are required to generate or verify Ibm3624 random PIN.
DecimalizationTable (string) -- [REQUIRED]
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624PinFromOffset (dict) --
Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
DecimalizationTable (string) -- [REQUIRED]
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
integer
The length of PIN under generation.
string
[REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
string
[REQUIRED]
The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
dict
Parameter information of a WrappedKeyBlock for encryption key exchange.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
Response Syntax
{
'GenerationKeyArn': 'string',
'GenerationKeyCheckValue': 'string',
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string',
'EncryptedPinBlock': 'string',
'PinData': {
'PinOffset': 'string',
'VerificationValue': 'string'
}
}
Response Structure
(dict) --
GenerationKeyArn (string) --
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
GenerationKeyCheckValue (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.
EncryptionKeyArn (string) --
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation. For ECDH, it is the keyARN of the asymmetric ECC key.
EncryptionKeyCheckValue (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.
EncryptedPinBlock (string) --
The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.
PinData (dict) --
The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
PinOffset (string) --
The PIN offset value.
VerificationValue (string) --
The unique data to identify a cardholder. In most cases, this is the same as cardholder's Primary Account Number (PAN). If a value is not provided, it defaults to PAN.
{'IncomingWrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': 'string'}}},
'OutgoingWrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': '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.
This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This 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 re-encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 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.
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:
DecryptData
EncryptData
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',
'DiffieHellmanSymmetricKey': {
'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={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[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.
string
[REQUIRED]
The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
string
[REQUIRED]
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
dict
[REQUIRED]
The attributes and values for incoming ciphertext.
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.
dict
[REQUIRED]
The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
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.
dict
The WrappedKeyBlock containing the encryption key of incoming ciphertext data.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
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.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
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.
{'IncomingWrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': 'string'}}},
'OutgoingWrappedKey': {'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': '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 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.
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',
'DiffieHellmanSymmetricKey': {
'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={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[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.
string
[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.
dict
[REQUIRED]
The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
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.
dict
[REQUIRED]
The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
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.
string
[REQUIRED]
The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
dict
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.
dict
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.
dict
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.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
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.
{'EncryptionWrappedKey': {'KeyCheckValueAlgorithm': 'CMAC | ANSI_X9_24',
'WrappedKeyMaterial': {'DiffieHellmanSymmetricKey': {'CertificateAuthorityPublicKeyIdentifier': 'string',
'KeyAlgorithm': 'TDES_2KEY '
'| '
'TDES_3KEY '
'| '
'AES_128 '
'| '
'AES_192 '
'| '
'AES_256',
'KeyDerivationFunction': 'NIST_SP800 '
'| '
'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256 '
'| '
'SHA_384 '
'| '
'SHA_512',
'PublicKeyCertificate': 'string',
'SharedInformation': 'string'},
'Tr31KeyBlock': 'string'}},
'PinBlockFormat': {'ISO_FORMAT_4'}}
Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.
This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.
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:
GeneratePinData
TranslatePinData
See also: AWS API Documentation
Request Syntax
client.verify_pin_data(
VerificationKeyIdentifier='string',
EncryptionKeyIdentifier='string',
VerificationAttributes={
'VisaPin': {
'PinVerificationKeyIndex': 123,
'VerificationValue': 'string'
},
'Ibm3624Pin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string',
'PinOffset': 'string'
}
},
EncryptedPinBlock='string',
PrimaryAccountNumber='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_3'|'ISO_FORMAT_4',
PinDataLength=123,
DukptAttributes={
'KeySerialNumber': 'string',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
EncryptionWrappedKey={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'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'
}
)
string
[REQUIRED]
The keyARN of the PIN verification key.
string
[REQUIRED]
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
dict
[REQUIRED]
The attributes and values for PIN data verification.
VisaPin (dict) --
Parameters that are required to generate or verify Visa PIN.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
VerificationValue (string) -- [REQUIRED]
Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
Ibm3624Pin (dict) --
Parameters that are required to generate or verify Ibm3624 PIN.
DecimalizationTable (string) -- [REQUIRED]
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
string
[REQUIRED]
The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
string
[REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
string
[REQUIRED]
The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
integer
The length of PIN being verified.
dict
The attributes and values for the DUKPT encrypted PIN block data.
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.
DukptDerivationType (string) -- [REQUIRED]
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.
dict
Parameter information of a WrappedKeyBlock for encryption key exchange.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
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.
dict
Response Syntax
{
'VerificationKeyArn': 'string',
'VerificationKeyCheckValue': 'string',
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string'
}
Response Structure
(dict) --
VerificationKeyArn (string) --
The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
VerificationKeyCheckValue (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.
EncryptionKeyArn (string) --
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
EncryptionKeyCheckValue (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.