2025/12/17 - Payment Cryptography Data Plane - 1 new3 updated api methods
Changes Support for AS2805 standard. Modifications to import-key and export-key to support AS2805 variants.
Establishes node-to-node initialization between payment processing nodes such as an acquirer, issuer or payment network using Australian Standard 2805 (AS2805).
During node-to-node initialization, both communicating nodes must validate that they possess the correct Key Encrypting Keys (KEKs) before proceeding with session key exchange. In AS2805, the sending KEK (KEKs) of one node corresponds to the receiving KEK (KEKr) of its partner node. Each node uses its KEK to encrypt and decrypt session keys exchanged between the nodes. A KEK can be created or imported into Amazon Web Services Payment Cryptography using either the CreateKey or ImportKey operations.
The node initiating communication can use GenerateAS2805KekValidation to generate a combined KEK validation request and KEK validation response to send to the partnering node for validation. When invoked, the API internally generates a random sending key encrypted under KEKs and provides a receiving key encrypted under KEKr as response. The initiating node sends the response returned by this API to its partner for validation.
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.
See also: AWS API Documentation
Request Syntax
client.generate_as2805_kek_validation(
KeyIdentifier='string',
KekValidationType={
'KekValidationRequest': {
'DeriveKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224'
},
'KekValidationResponse': {
'RandomKeySend': 'string'
}
},
RandomKeySendVariantMask='VARIANT_MASK_82C0'|'VARIANT_MASK_82'
)
string
[REQUIRED]
The keyARN of sending KEK that Amazon Web Services Payment Cryptography uses for node-to-node initialization
dict
[REQUIRED]
Parameter information for generating a random key for KEK validation to perform node-to-node initialization.
KekValidationRequest (dict) --
Parameter information for generating a KEK validation request during node-to-node initialization.
DeriveKeyAlgorithm (string) -- [REQUIRED]
The key derivation algorithm to use for generating a KEK validation request.
KekValidationResponse (dict) --
Parameter information for generating a KEK validation response during node-to-node initialization.
RandomKeySend (string) -- [REQUIRED]
The random key for generating a KEK validation response.
string
[REQUIRED]
The key variant to use for generating a random key for KEK validation during node-to-node initialization.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'RandomKeySend': 'string',
'RandomKeyReceive': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization
KeyCheckValue (string) --
The key check value (KCV) of the sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization.
RandomKeySend (string) --
The random key generated for sending KEK validation.
RandomKeyReceive (string) --
The random key generated for receiving KEK validation. The initiating node sends this key to its partner node for validation.
{'GenerationAttributes': {'Algorithm': {'AS2805_4_1'}}}
Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.
You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and the key must have KeyModesOfUse set to Generate.
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:
VerifyMac
See also: AWS API Documentation
Request Syntax
client.generate_mac(
KeyIdentifier='string',
MessageData='string',
GenerationAttributes={
'Algorithm': 'ISO9797_ALGORITHM1'|'ISO9797_ALGORITHM3'|'CMAC'|'HMAC'|'HMAC_SHA224'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'AS2805_4_1',
'EmvMac': {
'MajorKeyDerivationMode': 'EMV_OPTION_A'|'EMV_OPTION_B',
'PrimaryAccountNumber': 'string',
'PanSequenceNumber': 'string',
'SessionKeyDerivationMode': 'EMV_COMMON_SESSION_KEY'|'EMV2000'|'AMEX'|'MASTERCARD_SESSION_KEY'|'VISA',
'SessionKeyDerivationValue': {
'ApplicationCryptogram': 'string',
'ApplicationTransactionCounter': 'string'
}
},
'DukptIso9797Algorithm1': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
'DukptIso9797Algorithm3': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
'DukptCmac': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
}
},
MacLength=123
)
string
[REQUIRED]
The keyARN of the MAC generation encryption key.
string
[REQUIRED]
The data for which a MAC is under generation. This value must be hexBinary.
dict
[REQUIRED]
The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
Algorithm (string) --
The encryption algorithm for MAC generation or verification.
EmvMac (dict) --
Parameters that are required for MAC generation or verification using EMV MAC algorithm.
MajorKeyDerivationMode (string) -- [REQUIRED]
The method to use when deriving the master key for EMV MAC generation or verification.
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).
SessionKeyDerivationMode (string) -- [REQUIRED]
The method of deriving a session key for EMV MAC generation or verification.
SessionKeyDerivationValue (dict) -- [REQUIRED]
Parameters that are required to generate session key for EMV generation and verification.
ApplicationCryptogram (string) --
The cryptogram provided by the terminal during transaction processing.
ApplicationTransactionCounter (string) --
The transaction counter that is provided by the terminal during transaction processing.
DukptIso9797Algorithm1 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
DukptIso9797Algorithm3 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
DukptCmac (dict) --
Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
integer
The length of a MAC under generation.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'Mac': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.
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.
Mac (string) --
The MAC cryptogram generated within Amazon Web Services Payment Cryptography.
{'IncomingAs2805Attributes': {'SystemTraceAuditNumber': 'string',
'TransactionAmount': 'string'},
'IncomingTranslationAttributes': {'As2805Format0': {'PrimaryAccountNumber': 'string'}},
'OutgoingTranslationAttributes': {'As2805Format0': {'PrimaryAccountNumber': '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 Creating 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'
},
'As2805Format0': {
'PrimaryAccountNumber': 'string'
}
},
OutgoingTranslationAttributes={
'IsoFormat0': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat1': {}
,
'IsoFormat3': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat4': {
'PrimaryAccountNumber': 'string'
},
'As2805Format0': {
'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'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
'SharedInformation': 'string'
}
},
'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
},
OutgoingWrappedKey={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'CertificateAuthorityPublicKeyIdentifier': 'string',
'PublicKeyCertificate': 'string',
'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
'SharedInformation': 'string'
}
},
'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
},
IncomingAs2805Attributes={
'SystemTraceAuditNumber': 'string',
'TransactionAmount': 'string'
}
)
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 translation.
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 translation.
IsoFormat3 (dict) --
Parameters that are required for ISO9564 PIN format 3 translation.
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 translation.
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.
As2805Format0 (dict) --
Parameters that are required for AS2805 PIN format 0 translation.
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 translation.
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 translation.
IsoFormat3 (dict) --
Parameters that are required for ISO9564 PIN format 3 translation.
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 translation.
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.
As2805Format0 (dict) --
Parameters that are required for AS2805 PIN format 0 translation.
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
The attributes and values to use for incoming AS2805 encryption key for PIN block translation.
SystemTraceAuditNumber (string) -- [REQUIRED]
The system trace audit number for the transaction.
TransactionAmount (string) -- [REQUIRED]
The transaction amount for the transaction.
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.
{'VerificationAttributes': {'Algorithm': {'AS2805_4_1'}}}
Verifies a Message Authentication Code (MAC).
You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.
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:
GenerateMac
See also: AWS API Documentation
Request Syntax
client.verify_mac(
KeyIdentifier='string',
MessageData='string',
Mac='string',
VerificationAttributes={
'Algorithm': 'ISO9797_ALGORITHM1'|'ISO9797_ALGORITHM3'|'CMAC'|'HMAC'|'HMAC_SHA224'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'AS2805_4_1',
'EmvMac': {
'MajorKeyDerivationMode': 'EMV_OPTION_A'|'EMV_OPTION_B',
'PrimaryAccountNumber': 'string',
'PanSequenceNumber': 'string',
'SessionKeyDerivationMode': 'EMV_COMMON_SESSION_KEY'|'EMV2000'|'AMEX'|'MASTERCARD_SESSION_KEY'|'VISA',
'SessionKeyDerivationValue': {
'ApplicationCryptogram': 'string',
'ApplicationTransactionCounter': 'string'
}
},
'DukptIso9797Algorithm1': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
'DukptIso9797Algorithm3': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
'DukptCmac': {
'KeySerialNumber': 'string',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
}
},
MacLength=123
)
string
[REQUIRED]
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
string
[REQUIRED]
The data on for which MAC is under verification. This value must be hexBinary.
string
[REQUIRED]
The MAC being verified.
dict
[REQUIRED]
The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
Algorithm (string) --
The encryption algorithm for MAC generation or verification.
EmvMac (dict) --
Parameters that are required for MAC generation or verification using EMV MAC algorithm.
MajorKeyDerivationMode (string) -- [REQUIRED]
The method to use when deriving the master key for EMV MAC generation or verification.
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).
SessionKeyDerivationMode (string) -- [REQUIRED]
The method of deriving a session key for EMV MAC generation or verification.
SessionKeyDerivationValue (dict) -- [REQUIRED]
Parameters that are required to generate session key for EMV generation and verification.
ApplicationCryptogram (string) --
The cryptogram provided by the terminal during transaction processing.
ApplicationTransactionCounter (string) --
The transaction counter that is provided by the terminal during transaction processing.
DukptIso9797Algorithm1 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
DukptIso9797Algorithm3 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
DukptCmac (dict) --
Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
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.
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
DukptDerivationType (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.
integer
The length of the MAC.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.
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.