Package software.amazon.awssdk.services.paymentcryptographydata.model

Class DukptEncryptionAttributes

    • Method Detail

      • dukptKeyDerivationType

        public final DukptDerivationType dukptKeyDerivationType()

        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

        If the service returns an enum value that is not available in the current SDK version, dukptKeyDerivationType will return DukptDerivationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dukptKeyDerivationTypeAsString().

        Returns:
        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
        See Also:
        DukptDerivationType

      • dukptKeyDerivationTypeAsString

        public final String dukptKeyDerivationTypeAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, dukptKeyDerivationType will return DukptDerivationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dukptKeyDerivationTypeAsString().

        Returns:
        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
        See Also:
        DukptDerivationType

      • dukptKeyVariantAsString

        public final String dukptKeyVariantAsString()

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

        If the service returns an enum value that is not available in the current SDK version, dukptKeyVariant will return DukptKeyVariant.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dukptKeyVariantAsString().

        Returns:
        The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
        See Also:
        DukptKeyVariant

      • initializationVector

        public final String initializationVector()

        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.

        Returns:
        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

        public final String keySerialNumber()

        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.

        Returns:
        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

        public final DukptEncryptionMode mode()

        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.

        If the service returns an enum value that is not available in the current SDK version, mode will return DukptEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

        Returns:
        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.

        See Also:
        DukptEncryptionMode

      • modeAsString

        public final String modeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, mode will return DukptEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

        Returns:
        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.

        See Also:
        DukptEncryptionMode

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)