PaymentCryptographyDataPlane / Client / encrypt_data

encrypt_data#

PaymentCryptographyDataPlane.Client.encrypt_data(**kwargs)#

Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. 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 asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, you must already have a DUKPT key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key 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
GetPublicCertificate
ImportKey
ReEncryptData

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'
        },
        '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, 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 to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don’t provide a value, Amazon Web Services Payment Cryptography generates a random value.
  - 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 mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher’s single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
- Symmetric (dict) –
  
  Parameters that are required to perform encryption and decryption using symmetric keys.
  - InitializationVector (string) –
    
    An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
  - Mode (string) – [REQUIRED]
    
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher’s single-block operation to securely transform amounts of data larger than a block.
  - 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.

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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

Exceptions

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