PaymentCryptographyDataPlane / Client / encrypt_data

encrypt_data#

PaymentCryptographyDataPlane.Client.encrypt_data(**kwargs)#

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

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

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

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

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

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

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

Related operations:

See also: AWS API Documentation

Request Syntax

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

  • EncryptionAttributes (dict) –

    [REQUIRED]

    The encryption key type and attributes for plaintext encryption.

    Note

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

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

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

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

    • Emv (dict) –

      Parameters for plaintext encryption using EMV keys.

      • InitializationVector (string) –

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

      • MajorKeyDerivationMode (string) – [REQUIRED]

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

      • Mode (string) –

        The block cipher method to use for encryption.

      • PanSequenceNumber (string) – [REQUIRED]

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

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

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

    • Symmetric (dict) –

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

      • InitializationVector (string) –

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

      • Mode (string) – [REQUIRED]

        The block cipher method to use for encryption.

      • PaddingType (string) –

        The padding to be included with the data.

  • KeyIdentifier (string) –

    [REQUIRED]

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

  • PlainText (string) –

    [REQUIRED]

    The plaintext to be encrypted.

    Note

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • CipherText (string) –

      The encrypted ciphertext.

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

Exceptions

  • PaymentCryptographyDataPlane.Client.exceptions.ValidationException

  • PaymentCryptographyDataPlane.Client.exceptions.AccessDeniedException

  • PaymentCryptographyDataPlane.Client.exceptions.ResourceNotFoundException

  • PaymentCryptographyDataPlane.Client.exceptions.ThrottlingException

  • PaymentCryptographyDataPlane.Client.exceptions.InternalServerException