Skip to content

WrappedKey

Source code in docs_src/capo_payment_cryptography/types/wrapped_key.py
class WrappedKey(TypedDict, closed=True):
    wrapping_key_arn: "capo_payment_cryptography.types.key_arn.KeyArn"
    """<p>The <code>KeyARN</code> of the wrapped key.</p>"""
    wrapped_key_material_format: "capo_payment_cryptography.types.wrapped_key_material_format.WrappedKeyMaterialFormat"
    """<p>The key block format of a wrapped key.</p>"""
    key_material: "capo_payment_cryptography.types.key_material.KeyMaterial"
    """<p>Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.</p>"""
    key_check_value: NotRequired[
        "capo_payment_cryptography.types.key_check_value.KeyCheckValue"
    ]
    """<p>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.</p>"""
    key_check_value_algorithm: NotRequired[
        "capo_payment_cryptography.types.key_check_value_algorithm.KeyCheckValueAlgorithm"
    ]
    """<p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>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. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes.</p>"""

key_check_value instance-attribute

key_check_value: NotRequired[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.

key_check_value_algorithm instance-attribute

key_check_value_algorithm: NotRequired[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. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes.

key_material instance-attribute

key_material: KeyMaterial

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

wrapped_key_material_format instance-attribute

wrapped_key_material_format: WrappedKeyMaterialFormat

The key block format of a wrapped key.

wrapping_key_arn instance-attribute

wrapping_key_arn: KeyArn

The KeyARN of the wrapped key.