Package software.amazon.awssdk.services.paymentcryptography.model

Interface WrappedKey.Builder

    • Method Detail

      • keyCheckValue

        WrappedKey.Builder keyCheckValue​(String keyCheckValue)

        The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

        Parameters:
        keyCheckValue - The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyCheckValueAlgorithm

        WrappedKey.Builder keyCheckValueAlgorithm​(String keyCheckValueAlgorithm)

        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

        For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

        Parameters:
        keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

        For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyCheckValueAlgorithm, KeyCheckValueAlgorithm

      • keyCheckValueAlgorithm

        WrappedKey.Builder keyCheckValueAlgorithm​(KeyCheckValueAlgorithm keyCheckValueAlgorithm)

        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

        For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

        Parameters:
        keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

        For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyCheckValueAlgorithm, KeyCheckValueAlgorithm

      • keyMaterial

        WrappedKey.Builder keyMaterial​(String keyMaterial)

        Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

        Parameters:
        keyMaterial - Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • wrappedKeyMaterialFormat

        WrappedKey.Builder wrappedKeyMaterialFormat​(String wrappedKeyMaterialFormat)

        The key block format of a wrapped key.

        Parameters:
        wrappedKeyMaterialFormat - The key block format of a wrapped key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        WrappedKeyMaterialFormat, WrappedKeyMaterialFormat

      • wrappingKeyArn

        WrappedKey.Builder wrappingKeyArn​(String wrappingKeyArn)

        The KeyARN of the wrapped key.

        Parameters:
        wrappingKeyArn - The KeyARN of the wrapped key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.