AWS API Changes

2024/01/16 - Payment Cryptography Control Plane - 11 updated api methods

Changes Provide an additional option for key exchange using RSA wrap/unwrap in addition to tr-34/tr-31 in ImportKey and ExportKey operations. Added new key usage (type) TR31_M1_ISO_9797_1_MAC_KEY, for use with Generate/VerifyMac dataplane operations with ISO9797 Algorithm 1 MAC calculations.

CreateKey (updated)

Link ¶
Changes (request, response)
Request

{'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}

Response

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.

In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.

When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY ), key algorithm (example: TDES_2KEY ), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY ) and key modes of use (example: Encrypt ). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide . The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.

Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.

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

Related operations:

DeleteKey
GetKey
ListKeys

See also: AWS API Documentation

Request Syntax

client.create_key(
    Enabled=True|False,
    Exportable=True|False,
    KeyAttributes={
        'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
        'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
        'KeyModesOfUse': {
            'Decrypt': True|False,
            'DeriveKey': True|False,
            'Encrypt': True|False,
            'Generate': True|False,
            'NoRestrictions': True|False,
            'Sign': True|False,
            'Unwrap': True|False,
            'Verify': True|False,
            'Wrap': True|False
        },
        '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'
    },
    KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Enabled

boolean

param Enabled

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

type Exportable

boolean

param Exportable

[REQUIRED]

Specifies whether the key is exportable from the service.

type KeyAttributes

dict

param KeyAttributes

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

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.
KeyClass (string) -- [REQUIRED]

The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
KeyModesOfUse (dict) -- [REQUIRED]

The list of cryptographic operations that you can perform using the key.
- Decrypt (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
- DeriveKey (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
- Encrypt (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
- Generate (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
- NoRestrictions (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
- Sign (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
- Unwrap (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
- Verify (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
- Wrap (boolean) --
  
  Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
KeyUsage (string) -- [REQUIRED]

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

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 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 created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

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.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The key material that contains all the key attributes.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

DeleteKey (updated)

Link ¶
Changes (response)

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.

Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays . The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING . After the key is deleted, the KeyState is DELETE_COMPLETE .

You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.

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

Related operations:

RestoreKey
StartKeyUsage
StopKeyUsage

See also: AWS API Documentation

Request Syntax

client.delete_key(
    DeleteKeyInDays=123,
    KeyIdentifier='string'
)

type DeleteKeyInDays

integer

param DeleteKeyInDays

The waiting period for key deletion. The default value is seven days.

type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The KeyARN of the key that is scheduled for deletion.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The KeyARN of the key that is scheduled for deletion.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

ExportKey (updated)

Link ¶
Changes (request)

{'KeyMaterial': {'KeyCryptogram': {'CertificateAuthorityPublicKeyIdentifier': 'string',
                                   'WrappingKeyCertificate': 'string',
                                   'WrappingSpec': 'RSA_OAEP_SHA_256 | '
                                                   'RSA_OAEP_SHA_512'}}}

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 and RSA wrap and unwrap key exchange mechanism. 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.

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

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

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

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

Related operations:

GetParametersForExport
ImportKey

See also: AWS API Documentation

Request Syntax

client.export_key(
    ExportAttributes={
        'ExportDukptInitialKey': {
            'KeySerialNumber': 'string'
        },
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'
    },
    ExportKeyIdentifier='string',
    KeyMaterial={
        'KeyCryptogram': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'WrappingKeyCertificate': 'string',
            'WrappingSpec': 'RSA_OAEP_SHA_256'|'RSA_OAEP_SHA_512'
        },
        'Tr31KeyBlock': {
            'WrappingKeyIdentifier': 'string'
        },
        'Tr34KeyBlock': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'ExportToken': 'string',
            'KeyBlockFormat': 'X9_TR34_2012',
            'RandomNonce': 'string',
            'WrappingKeyCertificate': 'string'
        }
    }
)

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.

type ExportKeyIdentifier

string

param ExportKeyIdentifier

[REQUIRED]

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

type KeyMaterial

dict

param KeyMaterial

[REQUIRED]

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

Note

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

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.
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.
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.
- ExportToken (string) -- [REQUIRED]
  
  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 7 days. You can use the same export token to export multiple keys from the same service account.
- 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.
- WrappingKeyCertificate (string) -- [REQUIRED]
  
  The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- WrappedKey (dict) --
  
  The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. or a RSA WrappedKeyCryptogram.
  - 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.
  - KeyMaterial (string) --
    
    Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
  - WrappedKeyMaterialFormat (string) --
    
    The key block format of a wrapped key.
  - WrappingKeyArn (string) --
    
    The KeyARN of the wrapped key.

GetKey (updated)

Link ¶
Changes (response)

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.

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

Related operations:

CreateKey
DeleteKey
ListKeys

See also: AWS API Documentation

Request Syntax

client.get_key(
    KeyIdentifier='string'
)

type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The KeyARN of the Amazon Web Services Payment Cryptography key.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The key material, including the immutable and mutable data for the key.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

GetParametersForExport (updated)

Link ¶
Changes (request)

{'KeyMaterialType': {'KEY_CRYPTOGRAM'}}

Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.

The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.

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

client.get_parameters_for_export(
    KeyMaterialType='TR34_KEY_BLOCK'|'TR31_KEY_BLOCK'|'ROOT_PUBLIC_KEY_CERTIFICATE'|'TRUSTED_PUBLIC_KEY_CERTIFICATE'|'KEY_CRYPTOGRAM',
    SigningKeyAlgorithm='TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096'
)

type KeyMaterialType

string

param KeyMaterialType

[REQUIRED]

The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK . Export token is not required for TR-31 key export.

type SigningKeyAlgorithm

string

param SigningKeyAlgorithm

[REQUIRED]

The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is the only signing key algorithm allowed.

rtype

dict

returns

Response Syntax

{
    'ExportToken': 'string',
    'ParametersValidUntilTimestamp': datetime(2015, 1, 1),
    'SigningKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
    'SigningKeyCertificate': 'string',
    'SigningKeyCertificateChain': 'string'
}

Response Structure

(dict) --
- ExportToken (string) --
  
  The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
- ParametersValidUntilTimestamp (datetime) --
  
  The validity period of the export token.
- SigningKeyAlgorithm (string) --
  
  The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
- SigningKeyCertificate (string) --
  
  The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 7 days.
- SigningKeyCertificateChain (string) --
  
  The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).

GetParametersForImport (updated)

Link ¶
Changes (request)

{'KeyMaterialType': {'KEY_CRYPTOGRAM'}}

Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.

The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.

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

Related operations:

GetParametersForExport
ImportKey

See also: AWS API Documentation

Request Syntax

client.get_parameters_for_import(
    KeyMaterialType='TR34_KEY_BLOCK'|'TR31_KEY_BLOCK'|'ROOT_PUBLIC_KEY_CERTIFICATE'|'TRUSTED_PUBLIC_KEY_CERTIFICATE'|'KEY_CRYPTOGRAM',
    WrappingKeyAlgorithm='TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096'
)

type KeyMaterialType

string

param KeyMaterialType

[REQUIRED]

The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK ) and RSA WrappedKeyCryptogram ( KEY_CRYPTOGRAM ).

Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

type WrappingKeyAlgorithm

string

param WrappingKeyAlgorithm

[REQUIRED]

The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048 , RSA_3072 , RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.

rtype

dict

returns

Response Syntax

{
    'ImportToken': 'string',
    'ParametersValidUntilTimestamp': datetime(2015, 1, 1),
    'WrappingKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
    'WrappingKeyCertificate': 'string',
    'WrappingKeyCertificateChain': 'string'
}

Response Structure

(dict) --
- ImportToken (string) --
  
  The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
- ParametersValidUntilTimestamp (datetime) --
  
  The validity period of the import token.
- WrappingKeyAlgorithm (string) --
  
  The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock or RSA WrappedKeyCryptogram.
- WrappingKeyCertificate (string) --
  
  The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
- WrappingKeyCertificateChain (string) --
  
  The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).

ImportKey (updated)

Link ¶
Changes (request, response)
Request

{'KeyMaterial': {'KeyCryptogram': {'Exportable': 'boolean',
                                   'ImportToken': 'string',
                                   'KeyAttributes': {'KeyAlgorithm': 'TDES_2KEY '
                                                                     '| '
                                                                     'TDES_3KEY '
                                                                     '| '
                                                                     'AES_128 '
                                                                     '| '
                                                                     'AES_192 '
                                                                     '| '
                                                                     'AES_256 '
                                                                     '| '
                                                                     'RSA_2048 '
                                                                     '| '
                                                                     'RSA_3072 '
                                                                     '| '
                                                                     'RSA_4096',
                                                     'KeyClass': 'SYMMETRIC_KEY '
                                                                 '| '
                                                                 'ASYMMETRIC_KEY_PAIR '
                                                                 '| '
                                                                 'PRIVATE_KEY '
                                                                 '| PUBLIC_KEY',
                                                     'KeyModesOfUse': {'Decrypt': 'boolean',
                                                                       'DeriveKey': 'boolean',
                                                                       'Encrypt': 'boolean',
                                                                       'Generate': 'boolean',
                                                                       'NoRestrictions': 'boolean',
                                                                       'Sign': 'boolean',
                                                                       'Unwrap': 'boolean',
                                                                       'Verify': 'boolean',
                                                                       'Wrap': 'boolean'},
                                                     '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'},
                                   'WrappedKeyCryptogram': 'string',
                                   'WrappingSpec': 'RSA_OAEP_SHA_256 | '
                                                   'RSA_OAEP_SHA_512'},
                 'RootCertificatePublicKey': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}},
                 'TrustedCertificatePublicKey': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}}

Response

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

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.

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

client.import_key(
    Enabled=True|False,
    KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24',
    KeyMaterial={
        'KeyCryptogram': {
            'Exportable': True|False,
            'ImportToken': 'string',
            'KeyAttributes': {
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyModesOfUse': {
                    'Decrypt': True|False,
                    'DeriveKey': True|False,
                    'Encrypt': True|False,
                    'Generate': True|False,
                    'NoRestrictions': True|False,
                    'Sign': True|False,
                    'Unwrap': True|False,
                    'Verify': True|False,
                    'Wrap': True|False
                },
                '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'
            },
            'WrappedKeyCryptogram': 'string',
            'WrappingSpec': 'RSA_OAEP_SHA_256'|'RSA_OAEP_SHA_512'
        },
        'RootCertificatePublicKey': {
            'KeyAttributes': {
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyModesOfUse': {
                    'Decrypt': True|False,
                    'DeriveKey': True|False,
                    'Encrypt': True|False,
                    'Generate': True|False,
                    'NoRestrictions': True|False,
                    'Sign': True|False,
                    'Unwrap': True|False,
                    'Verify': True|False,
                    'Wrap': True|False
                },
                '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'
            },
            'PublicKeyCertificate': 'string'
        },
        'Tr31KeyBlock': {
            'WrappedKeyBlock': 'string',
            'WrappingKeyIdentifier': 'string'
        },
        'Tr34KeyBlock': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'ImportToken': 'string',
            'KeyBlockFormat': 'X9_TR34_2012',
            'RandomNonce': 'string',
            'SigningKeyCertificate': 'string',
            'WrappedKeyBlock': 'string'
        },
        'TrustedCertificatePublicKey': {
            'CertificateAuthorityPublicKeyIdentifier': 'string',
            'KeyAttributes': {
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyModesOfUse': {
                    'Decrypt': True|False,
                    'DeriveKey': True|False,
                    'Encrypt': True|False,
                    'Generate': True|False,
                    'NoRestrictions': True|False,
                    'Sign': True|False,
                    'Unwrap': True|False,
                    'Verify': True|False,
                    'Wrap': True|False
                },
                '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'
            },
            'PublicKeyCertificate': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Enabled

boolean

param Enabled

Specifies whether import key is enabled.

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.

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.

Note

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

KeyCryptogram (dict) --

Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
- Exportable (boolean) -- [REQUIRED]
  
  Specifies whether the key is exportable from the service.
- 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.
- 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.
  - 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.
  - KeyClass (string) -- [REQUIRED]
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
  - KeyModesOfUse (dict) -- [REQUIRED]
    
    The list of cryptographic operations that you can perform using the key.
    - Decrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
    - DeriveKey (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
    - Encrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
    - Generate (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
    - NoRestrictions (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
    - Sign (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
    - Unwrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
    - Verify (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
    - Wrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
  - KeyUsage (string) -- [REQUIRED]
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
- WrappedKeyCryptogram (string) -- [REQUIRED]
  
  The RSA wrapped key cryptogram under import.
- WrappingSpec (string) --
  
  The wrapping spec for the wrapped key cryptogram.
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.
  - 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.
  - KeyClass (string) -- [REQUIRED]
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
  - KeyModesOfUse (dict) -- [REQUIRED]
    
    The list of cryptographic operations that you can perform using the key.
    - Decrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
    - DeriveKey (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
    - Encrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
    - Generate (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
    - NoRestrictions (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
    - Sign (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
    - Unwrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
    - Verify (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
    - Wrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
  - KeyUsage (string) -- [REQUIRED]
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
- PublicKeyCertificate (string) -- [REQUIRED]
  
  Parameter information for root public key certificate import.
Tr31KeyBlock (dict) --

Parameter information for key material import using symmetric TR-31 key exchange method.
- WrappedKeyBlock (string) -- [REQUIRED]
  
  The TR-31 wrapped key block to import.
- WrappingKeyIdentifier (string) -- [REQUIRED]
  
  The KeyARN of the key that will decrypt or unwrap a TR-31 key block during 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.
- 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.
- 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.
- SigningKeyCertificate (string) -- [REQUIRED]
  
  The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
- WrappedKeyBlock (string) -- [REQUIRED]
  
  The TR-34 wrapped key block to import.
TrustedCertificatePublicKey (dict) --

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.
- 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.
  - 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.
  - KeyClass (string) -- [REQUIRED]
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
  - KeyModesOfUse (dict) -- [REQUIRED]
    
    The list of cryptographic operations that you can perform using the key.
    - Decrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
    - DeriveKey (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
    - Encrypt (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
    - Generate (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
    - NoRestrictions (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
    - Sign (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
    - Unwrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
    - Verify (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
    - Wrap (boolean) --
      
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
  - KeyUsage (string) -- [REQUIRED]
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
- PublicKeyCertificate (string) -- [REQUIRED]
  
  Parameter information for trusted public key certificate import.

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.

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.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

ListKeys (updated)

Link ¶
Changes (response)

{'Keys': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.

This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

CreateKey
DeleteKey
GetKey

See also: AWS API Documentation

Request Syntax

client.list_keys(
    KeyState='CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
    MaxResults=123,
    NextToken='string'
)

type KeyState

string

param KeyState

The key state of the keys you want to list.

type MaxResults

integer

param MaxResults

Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

type NextToken

string

param NextToken

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.

rtype

dict

returns

Response Syntax

{
    'Keys': [
        {
            'Enabled': True|False,
            'Exportable': True|False,
            'KeyArn': 'string',
            'KeyAttributes': {
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyModesOfUse': {
                    'Decrypt': True|False,
                    'DeriveKey': True|False,
                    'Encrypt': True|False,
                    'Generate': True|False,
                    'NoRestrictions': True|False,
                    'Sign': True|False,
                    'Unwrap': True|False,
                    'Verify': True|False,
                    'Wrap': True|False
                },
                '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'
            },
            'KeyCheckValue': 'string',
            'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Keys (list) --
  
  The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
  - (dict) --
    
    Metadata about an Amazon Web Services Payment Cryptography key.
    - 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.
    - 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.
      - 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.
      - KeyClass (string) --
        
        The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
      - KeyModesOfUse (dict) --
        
        The list of cryptographic operations that you can perform using the key.
        
        Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
        
        DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
        
        Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
        
        Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
        
        NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
        
        Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
        
        Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
        
        Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
        
        Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
      - KeyUsage (string) --
        
        The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    - 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.
    - KeyState (string) --
      
      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
- NextToken (string) --
  
  The token for the next set of results, or an empty or null value if there are no more results.

RestoreKey (updated)

Link ¶
Changes (response)

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.

During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE , and the value for deletePendingTimestamp is removed.

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

Related operations:

DeleteKey
StartKeyUsage
StopKeyUsage

See also: AWS API Documentation

Request Syntax

client.restore_key(
    KeyIdentifier='string'
)

type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

StartKeyUsage (updated)

Link ¶
Changes (response)

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography

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

Related operations:

StopKeyUsage

See also: AWS API Documentation

Request Syntax

client.start_key_usage(
    KeyIdentifier='string'
)

type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The KeyArn of the key.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.

StopKeyUsage (updated)

Link ¶
Changes (response)

{'Key': {'KeyAttributes': {'KeyUsage': {'TR31_M1_ISO_9797_1_MAC_KEY'}}}}

Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.

You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.

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

Related operations:

DeleteKey
StartKeyUsage

See also: AWS API Documentation

Request Syntax

client.stop_key_usage(
    KeyIdentifier='string'
)

type KeyIdentifier

string

param KeyIdentifier

[REQUIRED]

The KeyArn of the key.

rtype

dict

returns

Response Syntax

{
    'Key': {
        'CreateTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyModesOfUse': {
                'Decrypt': True|False,
                'DeriveKey': True|False,
                'Encrypt': True|False,
                'Generate': True|False,
                'NoRestrictions': True|False,
                'Sign': True|False,
                'Unwrap': True|False,
                'Verify': True|False,
                'Wrap': True|False
            },
            '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'
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Key (dict) --
  
  The KeyARN of the key.
  - CreateTimestamp (datetime) --
    
    The date and time when the key was created.
  - 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.
  - 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.
  - 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.
    - 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.
    - KeyClass (string) --
      
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - KeyModesOfUse (dict) --
      
      The list of cryptographic operations that you can perform using the key.
      - Decrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
      - DeriveKey (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
      - Encrypt (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
      - Generate (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
      - NoRestrictions (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage .
      - Sign (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
      - Unwrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
      - Verify (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
      - Wrap (boolean) --
        
        Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
    - KeyUsage (string) --
      
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
  - 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.
  - 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 .
  - KeyState (string) --
    
    The state of key that is being created or deleted.
  - 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.