Payment Cryptography Control Plane

2025/09/12 - Payment Cryptography Control Plane - 1 new2 updated api methods

Changes  Add support for certificates to be signed by 3rd party certificate authorities. New API GetCertificateSigningRequest API and support for providing certificates at run-time for tr-34 import/export

GetCertificateSigningRequest (new) Link ¶

Used to retrieve the public key for a keypair.

See also: AWS API Documentation

Request Syntax

client.get_certificate_signing_request(
    KeyIdentifier='string',
    SigningAlgorithm='SHA224'|'SHA256'|'SHA384'|'SHA512',
    CertificateSubject={
        'CommonName': 'string',
        'OrganizationUnit': 'string',
        'Organization': 'string',
        'City': 'string',
        'Country': 'string',
        'StateOrProvince': 'string',
        'EmailAddress': 'string'
    }
)
type KeyIdentifier:

string

param KeyIdentifier:

[REQUIRED]

Asymmetric key used for generating the certificate signing request

type SigningAlgorithm:

string

param SigningAlgorithm:

[REQUIRED]

Algorithm used to generate the certificate signing request

type CertificateSubject:

dict

param CertificateSubject:

[REQUIRED]

Certificate subject data

  • CommonName (string) -- [REQUIRED]

    Common Name to be used in the certificate signing request

  • OrganizationUnit (string) --

    Organization Unit to be used in the certificate signing request

  • Organization (string) --

    Organization to be used in the certificate signing request

  • City (string) --

    City to be used in the certificate signing request

  • Country (string) --

    Country to be used in the certificate signing request

  • StateOrProvince (string) --

    State Or Province to be used in the certificate signing request

  • EmailAddress (string) --

    Email to be used in the certificate signing request

rtype:

dict

returns:

Response Syntax

{
    'CertificateSigningRequest': 'string'
}

Response Structure

  • (dict) --

    • CertificateSigningRequest (string) --

      Certificate signing request

ExportKey (updated) Link ¶
Changes (request)
{'KeyMaterial': {'Tr34KeyBlock': {'SigningKeyCertificate': 'string',
                                  'SigningKeyIdentifier': 'string'}}}

Exports a key from 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 ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography

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, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) 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). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.

PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see Importing and exporting keys in the Amazon Web Services Payment Cryptography User Guide.

You can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN ( KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.

For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022.

To export initial keys (KEK) or IPEK using TR-34

Using this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. 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 key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.

To initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 30 days.

Next the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.

Set the following parameters:

  • ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.

  • ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.

  • KeyMaterial: Use Tr34KeyBlock parameters.

  • CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.

  • ExportToken: Obtained from KDH by calling GetParametersForImport.

  • WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.

When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.

To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap

Using this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.

Next call ExportKey and set the following parameters:

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

  • KeyMaterial: Set to KeyCryptogram.

  • WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.

When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.

To export working keys or IPEK using TR-31

Using this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.

Set the following parameters:

  • ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.

  • ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.

  • KeyMaterial: Use Tr31KeyBlock parameters.

To export working keys using ECDH

You can also use ECDH key agreement to export working keys in a TR-31 keyblock, where the wrapping key is an ECDH derived key.

To initiate a TR-31 key export using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling CreateKey. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ImportKey with input RootCertificatePublicKey for root CA or TrustedPublicKey for intermediate CA. You can then complete a TR-31 key export by deriving a shared wrapping key using the service ECC key pair, public certificate of your ECC key pair outside of Amazon Web Services Payment Cryptography, and the key derivation parameters including key derivation function, hash algorithm, derivation data, key algorithm.

  • KeyMaterial: Use DiffieHellmanTr31KeyBlock parameters.

  • PrivateKeyIdentifier: The KeyArn of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.

  • PublicKeyCertificate: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.

  • CertificateAuthorityPublicKeyIdentifier: The keyARN of the CA that signed the public key certificate of the receiving ECC key pair.

When this operation is successful, Amazon Web Services Payment Cryptography returns the working key as a TR-31 WrappedKeyBlock, where the wrapping key is the ECDH derived key.

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

Related operations:

See also: AWS API Documentation

Request Syntax

client.export_key(
    KeyMaterial={
        'Tr31KeyBlock': {
            'WrappingKeyIdentifier': 'string',
            'KeyBlockHeaders': {
                '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
                },
                'KeyExportability': 'EXPORTABLE'|'NON_EXPORTABLE'|'SENSITIVE',
                'KeyVersion': 'string',
                'OptionalBlocks': {
                    'string': 'string'
                }
            }
        },
        'Tr34KeyBlock': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'WrappingKeyCertificate': 'string',
            'ExportToken': 'string',
            'SigningKeyIdentifier': 'string',
            'SigningKeyCertificate': 'string',
            'KeyBlockFormat': 'X9_TR34_2012',
            'RandomNonce': 'string',
            'KeyBlockHeaders': {
                '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
                },
                'KeyExportability': 'EXPORTABLE'|'NON_EXPORTABLE'|'SENSITIVE',
                'KeyVersion': 'string',
                'OptionalBlocks': {
                    'string': 'string'
                }
            }
        },
        'KeyCryptogram': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'WrappingKeyCertificate': 'string',
            'WrappingSpec': 'RSA_OAEP_SHA_256'|'RSA_OAEP_SHA_512'
        },
        'DiffieHellmanTr31KeyBlock': {
            'PrivateKeyIdentifier': 'string',
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'PublicKeyCertificate': 'string',
            'DeriveKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
            'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
            'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
            'DerivationData': {
                'SharedInformation': 'string'
            },
            'KeyBlockHeaders': {
                '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
                },
                'KeyExportability': 'EXPORTABLE'|'NON_EXPORTABLE'|'SENSITIVE',
                'KeyVersion': 'string',
                'OptionalBlocks': {
                    'string': 'string'
                }
            }
        }
    },
    ExportKeyIdentifier='string',
    ExportAttributes={
        'ExportDukptInitialKey': {
            'KeySerialNumber': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
    }
)
type KeyMaterial:

dict

param KeyMaterial:

[REQUIRED]

The key block format type, for example, TR-34 or TR-31, to use during key material export.

  • Tr31KeyBlock (dict) --

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

    • WrappingKeyIdentifier (string) -- [REQUIRED]

      The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.

    • KeyBlockHeaders (dict) --

      Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

      • KeyModesOfUse (dict) --

        The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

        • 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.

      • KeyExportability (string) --

        Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

      • KeyVersion (string) --

        Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

      • OptionalBlocks (dict) --

        Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

        Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

        • (string) --

          • (string) --

  • Tr34KeyBlock (dict) --

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

    • CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]

      The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.

    • WrappingKeyCertificate (string) -- [REQUIRED]

      The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

    • ExportToken (string) --

      The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.

    • SigningKeyIdentifier (string) --

      Key Identifier used for signing the export key

    • SigningKeyCertificate (string) --

      Certificate used for signing the export key

    • KeyBlockFormat (string) -- [REQUIRED]

      The format of key block that Amazon Web Services Payment Cryptography will use during key export.

    • 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.

    • KeyBlockHeaders (dict) --

      Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

      • KeyModesOfUse (dict) --

        The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

        • 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.

      • KeyExportability (string) --

        Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

      • KeyVersion (string) --

        Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

      • OptionalBlocks (dict) --

        Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

        Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

        • (string) --

          • (string) --

  • KeyCryptogram (dict) --

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

    • CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]

      The KeyARN of the certificate chain that signs the wrapping key certificate during RSA wrap and unwrap key export.

    • WrappingKeyCertificate (string) -- [REQUIRED]

      The wrapping key certificate in PEM format (base64 encoded). Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

    • WrappingSpec (string) --

      The wrapping spec for the key under export.

  • DiffieHellmanTr31KeyBlock (dict) --

    Key derivation parameter information for key material export using asymmetric ECDH key exchange method.

    • PrivateKeyIdentifier (string) -- [REQUIRED]

      The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.

    • CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]

      The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.

    • PublicKeyCertificate (string) -- [REQUIRED]

      The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.

    • DeriveKeyAlgorithm (string) -- [REQUIRED]

      The key algorithm of the shared derived ECDH key.

    • KeyDerivationFunction (string) -- [REQUIRED]

      The key derivation function to use when deriving a key using ECDH.

    • KeyDerivationHashAlgorithm (string) -- [REQUIRED]

      The hash type to use when deriving a key using ECDH.

    • DerivationData (dict) -- [REQUIRED]

      The shared information used when deriving a key using ECDH.

      • SharedInformation (string) --

        A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

        It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

    • KeyBlockHeaders (dict) --

      Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

      • KeyModesOfUse (dict) --

        The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

        • 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.

      • KeyExportability (string) --

        Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

      • KeyVersion (string) --

        Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

      • OptionalBlocks (dict) --

        Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

        Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

        • (string) --

          • (string) --

type ExportKeyIdentifier:

string

param ExportKeyIdentifier:

[REQUIRED]

The KeyARN of the key under export from Amazon Web Services Payment Cryptography.

type ExportAttributes:

dict

param ExportAttributes:

The attributes for IPEK generation during export.

  • ExportDukptInitialKey (dict) --

    Parameter information for IPEK export.

    • KeySerialNumber (string) -- [REQUIRED]

      The KSN for IPEK generation using DUKPT.

      KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.

  • 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. Specify KCV for IPEK export only.

    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.

rtype:

dict

returns:

Response Syntax

{
    'WrappedKey': {
        'WrappingKeyArn': 'string',
        'WrappedKeyMaterialFormat': 'KEY_CRYPTOGRAM'|'TR31_KEY_BLOCK'|'TR34_KEY_BLOCK',
        'KeyMaterial': 'string',
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
    }
}

Response Structure

  • (dict) --

    • WrappedKey (dict) --

      The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. or a RSA WrappedKeyCryptogram.

      • WrappingKeyArn (string) --

        The KeyARN of the wrapped key.

      • WrappedKeyMaterialFormat (string) --

        The key block format of a wrapped key.

      • KeyMaterial (string) --

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

      • 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.

ImportKey (updated) Link ¶
Changes (request)
{'KeyMaterial': {'Tr34KeyBlock': {'WrappingKeyCertificate': 'string',
                                  'WrappingKeyIdentifier': 'string'}}}

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, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) 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.

PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see Importing and exporting keys in the Amazon Web Services Payment Cryptography User Guide.

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 30 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 30 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.

To import working keys using ECDH

You can also use ECDH key agreement to import working keys as a TR-31 keyblock, where the wrapping key is an ECDH derived key.

To initiate a TR-31 key import using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling CreateKey and then GetPublicKeyCertificate to retrieve its public key certificate. Next, you can then generate a TR-31 WrappedKeyBlock using your own ECC key pair, the public certificate of the service's ECC key pair, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ImportKey with input RootCertificatePublicKey for root CA or TrustedPublicKey for intermediate CA. To complete the TR-31 key import, you can use the following parameters. It is important that the ECDH key derivation parameters you use should match those used during import to derive the same shared wrapping key within Amazon Web Services Payment Cryptography.

  • KeyMaterial: Use DiffieHellmanTr31KeyBlock parameters.

  • PrivateKeyIdentifier: The KeyArn of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.

  • PublicKeyCertificate: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.

  • CertificateAuthorityPublicKeyIdentifier: The keyARN of the CA that signed the public key certificate of the receiving ECC key pair.

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

Related operations:

See also: AWS API Documentation

Request Syntax

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'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521',
                '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'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521',
                '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',
            'WrappingKeyIdentifier': 'string',
            'WrappingKeyCertificate': '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'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521',
                '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'
        },
        'DiffieHellmanTr31KeyBlock': {
            'PrivateKeyIdentifier': 'string',
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'PublicKeyCertificate': 'string',
            'DeriveKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
            'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
            'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
            'DerivationData': {
                'SharedInformation': 'string'
            },
            'WrappedKeyBlock': 'string'
        }
    },
    KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1',
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ReplicationRegions=[
        'string',
    ]
)
type KeyMaterial:

dict

param KeyMaterial:

[REQUIRED]

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

  • 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) --

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

    • WrappingKeyIdentifier (string) --

      Key Identifier used for unwrapping the import key

    • WrappingKeyCertificate (string) --

      Key Identifier used for unwrapping the import key

    • 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 30 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.

  • DiffieHellmanTr31KeyBlock (dict) --

    Key derivation parameter information for key material import using asymmetric ECDH key exchange method.

    • PrivateKeyIdentifier (string) -- [REQUIRED]

      The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.

    • CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]

      The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.

    • PublicKeyCertificate (string) -- [REQUIRED]

      The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.

    • DeriveKeyAlgorithm (string) -- [REQUIRED]

      The key algorithm of the shared derived ECDH key.

    • KeyDerivationFunction (string) -- [REQUIRED]

      The key derivation function to use when deriving a key using ECDH.

    • KeyDerivationHashAlgorithm (string) -- [REQUIRED]

      The hash type to use when deriving a key using ECDH.

    • DerivationData (dict) -- [REQUIRED]

      The shared information used when deriving a key using ECDH.

      • SharedInformation (string) --

        A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

        It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

    • WrappedKeyBlock (string) -- [REQUIRED]

      The ECDH wrapped key block to import.

type KeyCheckValueAlgorithm:

string

param 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.

type Enabled:

boolean

param Enabled:

Specifies whether import key is enabled.

type Tags:

list

param Tags:

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.

  • (dict) --

    A structure that contains information about a tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag.

type ReplicationRegions:

list

param ReplicationRegions:

A list of Amazon Web Services Regions for key replication operations.

Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key's replication configuration.

  • (string) --

    An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

    Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

rtype:

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'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521',
            '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'|'HMAC'|'SHA_1',
        '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),
        'DeriveKeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'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_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_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY',
        'MultiRegionKeyType': 'PRIMARY'|'REPLICA',
        'PrimaryRegion': 'string',
        'ReplicationStatus': {
            'string': {
                'Status': 'IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'SYNCHRONIZED',
                'StatusMessage': 'string'
            }
        },
        'UsingDefaultReplicationRegions': True|False
    }
}

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.

      • DeriveKeyUsage (string) --

        The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.

      • MultiRegionKeyType (string) --

        Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

        Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

      • PrimaryRegion (string) --

        An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

        Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

      • ReplicationStatus (dict) --

        Information about the replication status of the key across different regions.

        This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.

        • (string) --

          An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

          Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

          • (dict) --

            Represents the replication status information for a key in a replication region.

            This structure contains details about the current state of key replication, including any status messages and operational information about the replication process.

            • Status (string) --

              The current status of key replication in this region.

              This field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as SYNCRHONIZED, IN_PROGRESS, DELETE_IN_PROGRESS, or FAILED. This provides visibility into the replication process for monitoring and troubleshooting purposes.

            • StatusMessage (string) --

              A message that provides additional information about the current replication status of the key.

              This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.

      • UsingDefaultReplicationRegions (boolean) --

        Indicates whether this key is using the account's default replication regions configuration.

        When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.