Import Key
paymentcryptographycontrolplane_import_key | R Documentation |
Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography¶
Description¶
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 import_key
you can import symmetric keys using either
symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
To import a public root key certificate
You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
To import a public root key certificate
Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
Set the following parameters:
-
KeyMaterial
:RootCertificatePublicKey
-
KeyClass
:PUBLIC_KEY
-
KeyModesOfUse
:Verify
-
KeyUsage
:TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE
-
PublicKeyCertificate
: The public key certificate in PEM format (base64 encoded) of the private root key under import.
To import a trusted public key certificate
The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
-
KeyMaterial
:TrustedCertificatePublicKey
-
CertificateAuthorityPublicKeyIdentifier
:KeyArn
of theRootCertificatePublicKey
. -
KeyModesOfUse
andKeyUsage
: 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 get_parameters_for_import
. 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 import_key
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
: UseTr34KeyBlock
parameters. -
CertificateAuthorityPublicKeyIdentifier
: TheKeyARN
of the certificate chain that signed the KDH signing key certificate. -
ImportToken
: Obtained from KRD by callingget_parameters_for_import
. -
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
get_parameters_for_import
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 import_key
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 create_key
. To initiate a TR-31 key import, set the following
parameters:
-
KeyMaterial
: UseTr31KeyBlock
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
: TheKeyArn
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:
-
export_key
-
get_parameters_for_import
Usage¶
Arguments¶
KeyMaterial
[required] The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
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.
Enabled
Specifies whether import key is enabled.
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
tag_resource
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.
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Value¶
A list with the following syntax:
list(
Key = list(
KeyArn = "string",
KeyAttributes = list(
KeyUsage = "TR31_B0_BASE_DERIVATION_KEY"|"TR31_C0_CARD_VERIFICATION_KEY"|"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"|"TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION"|"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"|"TR31_E1_EMV_MKEY_CONFIDENTIALITY"|"TR31_E2_EMV_MKEY_INTEGRITY"|"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"|"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"|"TR31_E6_EMV_MKEY_OTHER"|"TR31_K0_KEY_ENCRYPTION_KEY"|"TR31_K1_KEY_BLOCK_PROTECTION_KEY"|"TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT"|"TR31_M3_ISO_9797_3_MAC_KEY"|"TR31_M1_ISO_9797_1_MAC_KEY"|"TR31_M6_ISO_9797_5_CMAC_KEY"|"TR31_M7_HMAC_KEY"|"TR31_P0_PIN_ENCRYPTION_KEY"|"TR31_P1_PIN_GENERATION_KEY"|"TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE"|"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"|"TR31_V2_VISA_PIN_VERIFICATION_KEY"|"TR31_K2_TR34_ASYMMETRIC_KEY",
KeyClass = "SYMMETRIC_KEY"|"ASYMMETRIC_KEY_PAIR"|"PRIVATE_KEY"|"PUBLIC_KEY",
KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096",
KeyModesOfUse = list(
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 = as.POSIXct(
"2015-01-01"
),
UsageStartTimestamp = as.POSIXct(
"2015-01-01"
),
UsageStopTimestamp = as.POSIXct(
"2015-01-01"
),
DeletePendingTimestamp = as.POSIXct(
"2015-01-01"
),
DeleteTimestamp = as.POSIXct(
"2015-01-01"
)
)
)
Request syntax¶
svc$import_key(
KeyMaterial = list(
RootCertificatePublicKey = list(
KeyAttributes = list(
KeyUsage = "TR31_B0_BASE_DERIVATION_KEY"|"TR31_C0_CARD_VERIFICATION_KEY"|"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"|"TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION"|"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"|"TR31_E1_EMV_MKEY_CONFIDENTIALITY"|"TR31_E2_EMV_MKEY_INTEGRITY"|"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"|"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"|"TR31_E6_EMV_MKEY_OTHER"|"TR31_K0_KEY_ENCRYPTION_KEY"|"TR31_K1_KEY_BLOCK_PROTECTION_KEY"|"TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT"|"TR31_M3_ISO_9797_3_MAC_KEY"|"TR31_M1_ISO_9797_1_MAC_KEY"|"TR31_M6_ISO_9797_5_CMAC_KEY"|"TR31_M7_HMAC_KEY"|"TR31_P0_PIN_ENCRYPTION_KEY"|"TR31_P1_PIN_GENERATION_KEY"|"TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE"|"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"|"TR31_V2_VISA_PIN_VERIFICATION_KEY"|"TR31_K2_TR34_ASYMMETRIC_KEY",
KeyClass = "SYMMETRIC_KEY"|"ASYMMETRIC_KEY_PAIR"|"PRIVATE_KEY"|"PUBLIC_KEY",
KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096",
KeyModesOfUse = list(
Encrypt = TRUE|FALSE,
Decrypt = TRUE|FALSE,
Wrap = TRUE|FALSE,
Unwrap = TRUE|FALSE,
Generate = TRUE|FALSE,
Sign = TRUE|FALSE,
Verify = TRUE|FALSE,
DeriveKey = TRUE|FALSE,
NoRestrictions = TRUE|FALSE
)
),
PublicKeyCertificate = "string"
),
TrustedCertificatePublicKey = list(
KeyAttributes = list(
KeyUsage = "TR31_B0_BASE_DERIVATION_KEY"|"TR31_C0_CARD_VERIFICATION_KEY"|"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"|"TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION"|"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"|"TR31_E1_EMV_MKEY_CONFIDENTIALITY"|"TR31_E2_EMV_MKEY_INTEGRITY"|"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"|"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"|"TR31_E6_EMV_MKEY_OTHER"|"TR31_K0_KEY_ENCRYPTION_KEY"|"TR31_K1_KEY_BLOCK_PROTECTION_KEY"|"TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT"|"TR31_M3_ISO_9797_3_MAC_KEY"|"TR31_M1_ISO_9797_1_MAC_KEY"|"TR31_M6_ISO_9797_5_CMAC_KEY"|"TR31_M7_HMAC_KEY"|"TR31_P0_PIN_ENCRYPTION_KEY"|"TR31_P1_PIN_GENERATION_KEY"|"TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE"|"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"|"TR31_V2_VISA_PIN_VERIFICATION_KEY"|"TR31_K2_TR34_ASYMMETRIC_KEY",
KeyClass = "SYMMETRIC_KEY"|"ASYMMETRIC_KEY_PAIR"|"PRIVATE_KEY"|"PUBLIC_KEY",
KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096",
KeyModesOfUse = list(
Encrypt = TRUE|FALSE,
Decrypt = TRUE|FALSE,
Wrap = TRUE|FALSE,
Unwrap = TRUE|FALSE,
Generate = TRUE|FALSE,
Sign = TRUE|FALSE,
Verify = TRUE|FALSE,
DeriveKey = TRUE|FALSE,
NoRestrictions = TRUE|FALSE
)
),
PublicKeyCertificate = "string",
CertificateAuthorityPublicKeyIdentifier = "string"
),
Tr31KeyBlock = list(
WrappingKeyIdentifier = "string",
WrappedKeyBlock = "string"
),
Tr34KeyBlock = list(
CertificateAuthorityPublicKeyIdentifier = "string",
SigningKeyCertificate = "string",
ImportToken = "string",
WrappedKeyBlock = "string",
KeyBlockFormat = "X9_TR34_2012",
RandomNonce = "string"
),
KeyCryptogram = list(
KeyAttributes = list(
KeyUsage = "TR31_B0_BASE_DERIVATION_KEY"|"TR31_C0_CARD_VERIFICATION_KEY"|"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"|"TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION"|"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"|"TR31_E1_EMV_MKEY_CONFIDENTIALITY"|"TR31_E2_EMV_MKEY_INTEGRITY"|"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"|"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"|"TR31_E6_EMV_MKEY_OTHER"|"TR31_K0_KEY_ENCRYPTION_KEY"|"TR31_K1_KEY_BLOCK_PROTECTION_KEY"|"TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT"|"TR31_M3_ISO_9797_3_MAC_KEY"|"TR31_M1_ISO_9797_1_MAC_KEY"|"TR31_M6_ISO_9797_5_CMAC_KEY"|"TR31_M7_HMAC_KEY"|"TR31_P0_PIN_ENCRYPTION_KEY"|"TR31_P1_PIN_GENERATION_KEY"|"TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE"|"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"|"TR31_V2_VISA_PIN_VERIFICATION_KEY"|"TR31_K2_TR34_ASYMMETRIC_KEY",
KeyClass = "SYMMETRIC_KEY"|"ASYMMETRIC_KEY_PAIR"|"PRIVATE_KEY"|"PUBLIC_KEY",
KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096",
KeyModesOfUse = list(
Encrypt = TRUE|FALSE,
Decrypt = TRUE|FALSE,
Wrap = TRUE|FALSE,
Unwrap = TRUE|FALSE,
Generate = TRUE|FALSE,
Sign = TRUE|FALSE,
Verify = TRUE|FALSE,
DeriveKey = TRUE|FALSE,
NoRestrictions = TRUE|FALSE
)
),
Exportable = TRUE|FALSE,
WrappedKeyCryptogram = "string",
ImportToken = "string",
WrappingSpec = "RSA_OAEP_SHA_256"|"RSA_OAEP_SHA_512"
)
),
KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24",
Enabled = TRUE|FALSE,
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)