PaymentCryptographyControlPlane / Client / create_key

create_key#

PaymentCryptographyControlPlane.Client.create_key(**kwargs)#

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:

See also: AWS API Documentation

Request Syntax

response = client.create_key(
    KeyAttributes={
        'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
        'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
        'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384',
        'KeyModesOfUse': {
            'Encrypt': True|False,
            'Decrypt': True|False,
            'Wrap': True|False,
            'Unwrap': True|False,
            'Generate': True|False,
            'Sign': True|False,
            'Verify': True|False,
            'DeriveKey': True|False,
            'NoRestrictions': True|False
        }
    },
    KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24',
    Exportable=True|False,
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • KeyAttributes (dict) –

    [REQUIRED]

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

    • KeyUsage (string) – [REQUIRED]

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

    • KeyClass (string) – [REQUIRED]

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

    • KeyAlgorithm (string) – [REQUIRED]

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

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

    • KeyModesOfUse (dict) – [REQUIRED]

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

      • Encrypt (boolean) –

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

      • Decrypt (boolean) –

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

      • Wrap (boolean) –

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

      • Unwrap (boolean) –

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

      • Generate (boolean) –

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

      • Sign (boolean) –

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

      • Verify (boolean) –

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

      • DeriveKey (boolean) –

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

      • NoRestrictions (boolean) –

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

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

  • Exportable (boolean) –

    [REQUIRED]

    Specifies whether the key is exportable from the service.

  • Enabled (boolean) – 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.

  • Tags (list) –

    Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. 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.

    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) – [REQUIRED]

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Key (dict) –

      The key material that contains all the key attributes.

      • KeyArn (string) –

        The Amazon Resource Name (ARN) of the key.

      • KeyAttributes (dict) –

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

        • KeyUsage (string) –

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

        • KeyClass (string) –

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

        • KeyAlgorithm (string) –

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

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

        • KeyModesOfUse (dict) –

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

          • Encrypt (boolean) –

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

          • Decrypt (boolean) –

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

          • Wrap (boolean) –

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

          • Unwrap (boolean) –

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

          • Generate (boolean) –

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

          • Sign (boolean) –

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

          • Verify (boolean) –

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

          • DeriveKey (boolean) –

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

          • NoRestrictions (boolean) –

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

      • KeyCheckValue (string) –

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

      • KeyCheckValueAlgorithm (string) –

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

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

      • Enabled (boolean) –

        Specifies whether the key is enabled.

      • Exportable (boolean) –

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

      • KeyState (string) –

        The state of key that is being created or deleted.

      • KeyOrigin (string) –

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

      • CreateTimestamp (datetime) –

        The date and time when the key was created.

      • UsageStartTimestamp (datetime) –

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

      • UsageStopTimestamp (datetime) –

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

      • DeletePendingTimestamp (datetime) –

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

      • DeleteTimestamp (datetime) –

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

Exceptions