PaymentCryptographyDataPlane / Client / verify_mac

verify_mac#

PaymentCryptographyDataPlane.Client.verify_mac(**kwargs)#

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

Request Syntax

response = client.verify_mac(
    KeyIdentifier='string',
    MessageData='string',
    Mac='string',
    VerificationAttributes={
        'Algorithm': 'ISO9797_ALGORITHM1'|'ISO9797_ALGORITHM3'|'CMAC'|'HMAC_SHA224'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512',
        '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
)

Parameters:

KeyIdentifier (string) –
[REQUIRED]

The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
MessageData (string) –
[REQUIRED]

The data on for which MAC is under verification. This value must be hexBinary.
Mac (string) –
[REQUIRED]

The MAC being verified.
VerificationAttributes (dict) –
[REQUIRED]

The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Algorithm, EmvMac, DukptIso9797Algorithm1, DukptIso9797Algorithm3, DukptCmac.
- 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.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: ApplicationCryptogram, ApplicationTransactionCounter.
    - 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.
MacLength (integer) – The length of the MAC.

Return type:

dict

Returns:

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.

Exceptions

PaymentCryptographyDataPlane.Client.exceptions.ValidationException
PaymentCryptographyDataPlane.Client.exceptions.VerificationFailedException
PaymentCryptographyDataPlane.Client.exceptions.AccessDeniedException
PaymentCryptographyDataPlane.Client.exceptions.ResourceNotFoundException
PaymentCryptographyDataPlane.Client.exceptions.ThrottlingException
PaymentCryptographyDataPlane.Client.exceptions.InternalServerException