Skip to content

DukptEncryptionAttributes

Source code in docs_src/capo_payment_cryptography_data/types/dukpt_encryption_attributes.py
class DukptEncryptionAttributes(TypedDict, closed=True):
    key_serial_number: "capo_payment_cryptography_data.types.hex_length16_or20_or24.HexLength16Or20Or24"
    """<p>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.</p>"""
    mode: NotRequired[
        "capo_payment_cryptography_data.types.dukpt_encryption_mode.DukptEncryptionMode"
    ]
    """<p>The block cipher method to use for encryption.</p> <p>The default is CBC.</p>"""
    dukpt_key_derivation_type: NotRequired[
        "capo_payment_cryptography_data.types.dukpt_derivation_type.DukptDerivationType"
    ]
    """<p>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 <code>AES_128</code> as a derivation type for a BDK of <code>AES_128</code> or <code>TDES_2KEY</code> </p>"""
    dukpt_key_variant: NotRequired[
        "capo_payment_cryptography_data.types.dukpt_key_variant.DukptKeyVariant"
    ]
    """<p>The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.</p>"""
    initialization_vector: NotRequired[
        "capo_payment_cryptography_data.types.initialization_vector_type.InitializationVectorType"
    ]
    """<p>An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.</p>"""

dukpt_key_derivation_type instance-attribute

dukpt_key_derivation_type: NotRequired[DukptDerivationType]

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

dukpt_key_variant instance-attribute

dukpt_key_variant: NotRequired[DukptKeyVariant]

The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

initialization_vector instance-attribute

initialization_vector: NotRequired[InitializationVectorType]

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

key_serial_number instance-attribute

key_serial_number: HexLength16Or20Or24

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 instance-attribute

mode: NotRequired[DukptEncryptionMode]

The block cipher method to use for encryption.

The default is CBC.