PaymentCryptographyControlPlane / Client / import_key

import_key

PaymentCryptographyControlPlane.Client.import_key(**kwargs)

Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.

Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.

For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.

The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.

You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.

To import a public root key certificate

You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.

To import a public root key certificate

Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.

Set the following parameters:

• KeyMaterial: RootCertificatePublicKey

• KeyClass: PUBLIC_KEY

• KeyModesOfUse: Verify

• KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE

• PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.

To import a trusted public key certificate

The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:

• KeyMaterial: TrustedCertificatePublicKey

• CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.

• KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.

• PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.

To import initial keys (KEK or ZMK or similar) using TR-34

Using this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.

To initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.

Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.

Set the following parameters:

• KeyMaterial: Use Tr34KeyBlock parameters.

• CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.

• ImportToken: Obtained from KRD by calling GetParametersForImport.

• WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.

• SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.

To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap

Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.

You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.

To import working keys using TR-31

Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:

• KeyMaterial: Use Tr31KeyBlock parameters.

• WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.

• WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.

Cross-account use: This operation can’t be used across different Amazon Web Services accounts.

Related operations:

• ExportKey

• GetParametersForImport

See also: AWS API Documentation

Request Syntax

response = client.import_key(
    KeyMaterial={
        'RootCertificatePublicKey': {
            'KeyAttributes': {
                'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyModesOfUse': {
                    'Encrypt': True|False,
                    'Decrypt': True|False,
                    'Wrap': True|False,
                    'Unwrap': True|False,
                    'Generate': True|False,
                    'Sign': True|False,
                    'Verify': True|False,
                    'DeriveKey': True|False,
                    'NoRestrictions': True|False
                }
            },
            'PublicKeyCertificate': 'string'
        },
        'TrustedCertificatePublicKey': {
            'KeyAttributes': {
                'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyModesOfUse': {
                    'Encrypt': True|False,
                    'Decrypt': True|False,
                    'Wrap': True|False,
                    'Unwrap': True|False,
                    'Generate': True|False,
                    'Sign': True|False,
                    'Verify': True|False,
                    'DeriveKey': True|False,
                    'NoRestrictions': True|False
                }
            },
            'PublicKeyCertificate': 'string',
            'CertificateAuthorityPublicKeyIdentifier': 'string'
        },
        'Tr31KeyBlock': {
            'WrappingKeyIdentifier': 'string',
            'WrappedKeyBlock': 'string'
        },
        'Tr34KeyBlock': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'SigningKeyCertificate': 'string',
            'ImportToken': 'string',
            'WrappedKeyBlock': 'string',
            'KeyBlockFormat': 'X9_TR34_2012',
            'RandomNonce': 'string'
        },
        'KeyCryptogram': {
            'KeyAttributes': {
                'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyModesOfUse': {
                    'Encrypt': True|False,
                    'Decrypt': True|False,
                    'Wrap': True|False,
                    'Unwrap': True|False,
                    'Generate': True|False,
                    'Sign': True|False,
                    'Verify': True|False,
                    'DeriveKey': True|False,
                    'NoRestrictions': True|False
                }
            },
            'Exportable': True|False,
            'WrappedKeyCryptogram': 'string',
            'ImportToken': 'string',
            'WrappingSpec': 'RSA_OAEP_SHA_256'|'RSA_OAEP_SHA_512'
        }
    },
    KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24',
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• KeyMaterial (dict) –

  [REQUIRED]

  The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: RootCertificatePublicKey, TrustedCertificatePublicKey, Tr31KeyBlock, Tr34KeyBlock, KeyCryptogram.

  • RootCertificatePublicKey (dict) –

    Parameter information for root public key certificate import.

    • KeyAttributes (dict) – [REQUIRED]

      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.

      • KeyUsage (string) – [REQUIRED]

        The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

      • KeyClass (string) – [REQUIRED]

        The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

      • KeyAlgorithm (string) – [REQUIRED]

        The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

        For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      • KeyModesOfUse (dict) – [REQUIRED]

        The list of cryptographic operations that you can perform using the key.

        • Encrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

        • Decrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

        • Wrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

        • Unwrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

        • Generate (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

        • Sign (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

        • Verify (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

        • DeriveKey (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

        • NoRestrictions (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

    • PublicKeyCertificate (string) – [REQUIRED]

      Parameter information for root public key certificate import.

  • TrustedCertificatePublicKey (dict) –

    Parameter information for trusted public key certificate import.

    • KeyAttributes (dict) – [REQUIRED]

      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.

      • KeyUsage (string) – [REQUIRED]

        The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

      • KeyClass (string) – [REQUIRED]

        The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

      • KeyAlgorithm (string) – [REQUIRED]

        The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

        For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      • KeyModesOfUse (dict) – [REQUIRED]

        The list of cryptographic operations that you can perform using the key.

        • Encrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

        • Decrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

        • Wrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

        • Unwrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

        • Generate (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

        • Sign (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

        • Verify (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

        • DeriveKey (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

        • NoRestrictions (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

    • PublicKeyCertificate (string) – [REQUIRED]

      Parameter information for trusted public key certificate import.

    • CertificateAuthorityPublicKeyIdentifier (string) – [REQUIRED]

      The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.

  • Tr31KeyBlock (dict) –

    Parameter information for key material import using symmetric TR-31 key exchange method.

    • WrappingKeyIdentifier (string) – [REQUIRED]

      The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.

    • WrappedKeyBlock (string) – [REQUIRED]

      The TR-31 wrapped key block to import.

  • Tr34KeyBlock (dict) –

    Parameter information for key material import using the asymmetric TR-34 key exchange method.

    • CertificateAuthorityPublicKeyIdentifier (string) – [REQUIRED]

      The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.

    • SigningKeyCertificate (string) – [REQUIRED]

      The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.

    • ImportToken (string) – [REQUIRED]

      The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.

    • WrappedKeyBlock (string) – [REQUIRED]

      The TR-34 wrapped key block to import.

    • KeyBlockFormat (string) – [REQUIRED]

      The key block format to use during key import. The only value allowed is X9_TR34_2012.

    • RandomNonce (string) –

      A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.

  • KeyCryptogram (dict) –

    Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.

    • KeyAttributes (dict) – [REQUIRED]

      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

      • KeyUsage (string) – [REQUIRED]

        The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

      • KeyClass (string) – [REQUIRED]

        The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

      • KeyAlgorithm (string) – [REQUIRED]

        The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

        For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      • KeyModesOfUse (dict) – [REQUIRED]

        The list of cryptographic operations that you can perform using the key.

        • Encrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

        • Decrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

        • Wrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

        • Unwrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

        • Generate (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

        • Sign (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

        • Verify (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

        • DeriveKey (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

        • NoRestrictions (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

    • Exportable (boolean) – [REQUIRED]

      Specifies whether the key is exportable from the service.

    • WrappedKeyCryptogram (string) – [REQUIRED]

      The RSA wrapped key cryptogram under import.

    • ImportToken (string) – [REQUIRED]

      The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.

    • WrappingSpec (string) –

      The wrapping spec for the wrapped key cryptogram.

• KeyCheckValueAlgorithm (string) –

  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.

• Enabled (boolean) – Specifies whether import key is enabled.

• Tags (list) –

  Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

  Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can’t have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

  Warning

  Don’t include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

  Note

  Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

  • (dict) –

    A structure that contains information about a tag.

    • Key (string) – [REQUIRED]

      The key of the tag.

    • Value (string) –

      The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'Key': {
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyModesOfUse': {
                'Encrypt': True|False,
                'Decrypt': True|False,
                'Wrap': True|False,
                'Unwrap': True|False,
                'Generate': True|False,
                'Sign': True|False,
                'Verify': True|False,
                'DeriveKey': True|False,
                'NoRestrictions': True|False
            }
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'CreateTimestamp': datetime(2015, 1, 1),
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • Key (dict) –

    The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.

    • KeyArn (string) –

      The Amazon Resource Name (ARN) of the key.

    • KeyAttributes (dict) –

      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

      • KeyUsage (string) –

        The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

      • KeyClass (string) –

        The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

      • KeyAlgorithm (string) –

        The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

        For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      • KeyModesOfUse (dict) –

        The list of cryptographic operations that you can perform using the key.

        • Encrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

        • Decrypt (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

        • Wrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

        • Unwrap (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

        • Generate (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

        • Sign (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

        • Verify (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

        • DeriveKey (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

        • NoRestrictions (boolean) –

          Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

    • KeyCheckValue (string) –

      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.

    • KeyCheckValueAlgorithm (string) –

      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.

    • Enabled (boolean) –

      Specifies whether the key is enabled.

    • Exportable (boolean) –

      Specifies whether the key is exportable. This data is immutable after the key is created.

    • KeyState (string) –

      The state of key that is being created or deleted.

    • KeyOrigin (string) –

      The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

    • CreateTimestamp (datetime) –

      The date and time when the key was created.

    • UsageStartTimestamp (datetime) –

      The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

    • UsageStopTimestamp (datetime) –

      The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

    • DeletePendingTimestamp (datetime) –

      The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

    • DeleteTimestamp (datetime) –

      The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

Exceptions

• PaymentCryptographyControlPlane.Client.exceptions.ServiceQuotaExceededException

• PaymentCryptographyControlPlane.Client.exceptions.ServiceUnavailableException

• PaymentCryptographyControlPlane.Client.exceptions.ValidationException

• PaymentCryptographyControlPlane.Client.exceptions.ConflictException

• PaymentCryptographyControlPlane.Client.exceptions.AccessDeniedException

• PaymentCryptographyControlPlane.Client.exceptions.ResourceNotFoundException

• PaymentCryptographyControlPlane.Client.exceptions.ThrottlingException

• PaymentCryptographyControlPlane.Client.exceptions.InternalServerException