aws-sdk 2.1603.0 → 2.1604.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -28,11 +28,11 @@ declare class PaymentCryptography extends Service {
28
28
  */
29
29
  createKey(callback?: (err: AWSError, data: PaymentCryptography.Types.CreateKeyOutput) => void): Request<PaymentCryptography.Types.CreateKeyOutput, AWSError>;
30
30
  /**
31
- * Deletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias
31
+ * Deletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias
32
32
  */
33
33
  deleteAlias(params: PaymentCryptography.Types.DeleteAliasInput, callback?: (err: AWSError, data: PaymentCryptography.Types.DeleteAliasOutput) => void): Request<PaymentCryptography.Types.DeleteAliasOutput, AWSError>;
34
34
  /**
35
- * Deletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias
35
+ * Deletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias
36
36
  */
37
37
  deleteAlias(callback?: (err: AWSError, data: PaymentCryptography.Types.DeleteAliasOutput) => void): Request<PaymentCryptography.Types.DeleteAliasOutput, AWSError>;
38
38
  /**
@@ -44,11 +44,11 @@ declare class PaymentCryptography extends Service {
44
44
  */
45
45
  deleteKey(callback?: (err: AWSError, data: PaymentCryptography.Types.DeleteKeyOutput) => void): Request<PaymentCryptography.Types.DeleteKeyOutput, AWSError>;
46
46
  /**
47
- * 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
47
+ * 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. For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography. The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022. Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type. 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
48
48
  */
49
49
  exportKey(params: PaymentCryptography.Types.ExportKeyInput, callback?: (err: AWSError, data: PaymentCryptography.Types.ExportKeyOutput) => void): Request<PaymentCryptography.Types.ExportKeyOutput, AWSError>;
50
50
  /**
51
- * 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
51
+ * 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. For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography. The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022. Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type. 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
52
52
  */
53
53
  exportKey(callback?: (err: AWSError, data: PaymentCryptography.Types.ExportKeyOutput) => void): Request<PaymentCryptography.Types.ExportKeyOutput, AWSError>;
54
54
  /**
@@ -204,14 +204,6 @@ declare namespace PaymentCryptography {
204
204
  Alias: Alias;
205
205
  }
206
206
  export interface CreateKeyInput {
207
- /**
208
- * 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.
209
- */
210
- Enabled?: Boolean;
211
- /**
212
- * Specifies whether the key is exportable from the service.
213
- */
214
- Exportable: Boolean;
215
207
  /**
216
208
  * 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.
217
209
  */
@@ -220,6 +212,14 @@ declare namespace PaymentCryptography {
220
212
  * 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.
221
213
  */
222
214
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
215
+ /**
216
+ * Specifies whether the key is exportable from the service.
217
+ */
218
+ Exportable: Boolean;
219
+ /**
220
+ * 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.
221
+ */
222
+ Enabled?: Boolean;
223
223
  /**
224
224
  * 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. 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.
225
225
  */
@@ -240,14 +240,14 @@ declare namespace PaymentCryptography {
240
240
  export interface DeleteAliasOutput {
241
241
  }
242
242
  export interface DeleteKeyInput {
243
- /**
244
- * The waiting period for key deletion. The default value is seven days.
245
- */
246
- DeleteKeyInDays?: DeleteKeyInputDeleteKeyInDaysInteger;
247
243
  /**
248
244
  * The KeyARN of the key that is scheduled for deletion.
249
245
  */
250
246
  KeyIdentifier: KeyArnOrKeyAliasType;
247
+ /**
248
+ * The waiting period for key deletion. The default value is seven days.
249
+ */
250
+ DeleteKeyInDays?: DeleteKeyInputDeleteKeyInDaysInteger;
251
251
  }
252
252
  export type DeleteKeyInputDeleteKeyInDaysInteger = number;
253
253
  export interface DeleteKeyOutput {
@@ -288,23 +288,19 @@ declare namespace PaymentCryptography {
288
288
  }
289
289
  export interface ExportKeyInput {
290
290
  /**
291
- * The attributes for IPEK generation during export.
291
+ * The key block format type, for example, TR-34 or TR-31, to use during key material export.
292
292
  */
293
- ExportAttributes?: ExportAttributes;
293
+ KeyMaterial: ExportKeyMaterial;
294
294
  /**
295
295
  * The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
296
296
  */
297
297
  ExportKeyIdentifier: KeyArnOrKeyAliasType;
298
298
  /**
299
- * The key block format type, for example, TR-34 or TR-31, to use during key material export.
299
+ * The attributes for IPEK generation during export.
300
300
  */
301
- KeyMaterial: ExportKeyMaterial;
301
+ ExportAttributes?: ExportAttributes;
302
302
  }
303
303
  export interface ExportKeyMaterial {
304
- /**
305
- * Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
306
- */
307
- KeyCryptogram?: ExportKeyCryptogram;
308
304
  /**
309
305
  * Parameter information for key material export using symmetric TR-31 key exchange method.
310
306
  */
@@ -313,6 +309,10 @@ declare namespace PaymentCryptography {
313
309
  * Parameter information for key material export using the asymmetric TR-34 key exchange method.
314
310
  */
315
311
  Tr34KeyBlock?: ExportTr34KeyBlock;
312
+ /**
313
+ * Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
314
+ */
315
+ KeyCryptogram?: ExportKeyCryptogram;
316
316
  }
317
317
  export interface ExportKeyOutput {
318
318
  /**
@@ -326,12 +326,20 @@ declare namespace PaymentCryptography {
326
326
  * The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
327
327
  */
328
328
  WrappingKeyIdentifier: KeyArnOrKeyAliasType;
329
+ /**
330
+ * Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
331
+ */
332
+ KeyBlockHeaders?: KeyBlockHeaders;
329
333
  }
330
334
  export interface ExportTr34KeyBlock {
331
335
  /**
332
336
  * The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
333
337
  */
334
338
  CertificateAuthorityPublicKeyIdentifier: KeyArnOrKeyAliasType;
339
+ /**
340
+ * The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
341
+ */
342
+ WrappingKeyCertificate: CertificateType;
335
343
  /**
336
344
  * 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.
337
345
  */
@@ -345,9 +353,9 @@ declare namespace PaymentCryptography {
345
353
  */
346
354
  RandomNonce?: HexLength16;
347
355
  /**
348
- * The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
356
+ * Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
349
357
  */
350
- WrappingKeyCertificate: CertificateType;
358
+ KeyBlockHeaders?: KeyBlockHeaders;
351
359
  }
352
360
  export interface GetAliasInput {
353
361
  /**
@@ -385,25 +393,25 @@ declare namespace PaymentCryptography {
385
393
  }
386
394
  export interface GetParametersForExportOutput {
387
395
  /**
388
- * 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.
396
+ * 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.
389
397
  */
390
- ExportToken: ExportTokenId;
398
+ SigningKeyCertificate: CertificateType;
391
399
  /**
392
- * The validity period of the export token.
400
+ * The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).
393
401
  */
394
- ParametersValidUntilTimestamp: Timestamp;
402
+ SigningKeyCertificateChain: CertificateType;
395
403
  /**
396
404
  * The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
397
405
  */
398
406
  SigningKeyAlgorithm: KeyAlgorithm;
399
407
  /**
400
- * 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.
408
+ * 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.
401
409
  */
402
- SigningKeyCertificate: CertificateType;
410
+ ExportToken: ExportTokenId;
403
411
  /**
404
- * The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).
412
+ * The validity period of the export token.
405
413
  */
406
- SigningKeyCertificateChain: CertificateType;
414
+ ParametersValidUntilTimestamp: Timestamp;
407
415
  }
408
416
  export interface GetParametersForImportInput {
409
417
  /**
@@ -417,25 +425,25 @@ declare namespace PaymentCryptography {
417
425
  }
418
426
  export interface GetParametersForImportOutput {
419
427
  /**
420
- * 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.
428
+ * 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.
421
429
  */
422
- ImportToken: ImportTokenId;
430
+ WrappingKeyCertificate: CertificateType;
423
431
  /**
424
- * The validity period of the import token.
432
+ * The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).
425
433
  */
426
- ParametersValidUntilTimestamp: Timestamp;
434
+ WrappingKeyCertificateChain: CertificateType;
427
435
  /**
428
436
  * The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock or RSA WrappedKeyCryptogram.
429
437
  */
430
438
  WrappingKeyAlgorithm: KeyAlgorithm;
431
439
  /**
432
- * 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.
440
+ * 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.
433
441
  */
434
- WrappingKeyCertificate: CertificateType;
442
+ ImportToken: ImportTokenId;
435
443
  /**
436
- * The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).
444
+ * The validity period of the import token.
437
445
  */
438
- WrappingKeyCertificateChain: CertificateType;
446
+ ParametersValidUntilTimestamp: Timestamp;
439
447
  }
440
448
  export interface GetPublicKeyCertificateInput {
441
449
  /**
@@ -456,19 +464,19 @@ declare namespace PaymentCryptography {
456
464
  export type HexLength16 = string;
457
465
  export type HexLength20Or24 = string;
458
466
  export interface ImportKeyCryptogram {
467
+ KeyAttributes: KeyAttributes;
459
468
  /**
460
469
  * Specifies whether the key is exportable from the service.
461
470
  */
462
471
  Exportable: Boolean;
463
- /**
464
- * 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.
465
- */
466
- ImportToken: ImportTokenId;
467
- KeyAttributes: KeyAttributes;
468
472
  /**
469
473
  * The RSA wrapped key cryptogram under import.
470
474
  */
471
475
  WrappedKeyCryptogram: WrappedKeyCryptogram;
476
+ /**
477
+ * 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.
478
+ */
479
+ ImportToken: ImportTokenId;
472
480
  /**
473
481
  * The wrapping spec for the wrapped key cryptogram.
474
482
  */
@@ -476,31 +484,31 @@ declare namespace PaymentCryptography {
476
484
  }
477
485
  export interface ImportKeyInput {
478
486
  /**
479
- * Specifies whether import key is enabled.
487
+ * The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
480
488
  */
481
- Enabled?: Boolean;
489
+ KeyMaterial: ImportKeyMaterial;
482
490
  /**
483
491
  * 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.
484
492
  */
485
493
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
486
494
  /**
487
- * The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
495
+ * Specifies whether import key is enabled.
488
496
  */
489
- KeyMaterial: ImportKeyMaterial;
497
+ Enabled?: Boolean;
490
498
  /**
491
499
  * 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. 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.
492
500
  */
493
501
  Tags?: Tags;
494
502
  }
495
503
  export interface ImportKeyMaterial {
496
- /**
497
- * Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
498
- */
499
- KeyCryptogram?: ImportKeyCryptogram;
500
504
  /**
501
505
  * Parameter information for root public key certificate import.
502
506
  */
503
507
  RootCertificatePublicKey?: RootCertificatePublicKey;
508
+ /**
509
+ * Parameter information for trusted public key certificate import.
510
+ */
511
+ TrustedCertificatePublicKey?: TrustedCertificatePublicKey;
504
512
  /**
505
513
  * Parameter information for key material import using symmetric TR-31 key exchange method.
506
514
  */
@@ -510,9 +518,9 @@ declare namespace PaymentCryptography {
510
518
  */
511
519
  Tr34KeyBlock?: ImportTr34KeyBlock;
512
520
  /**
513
- * Parameter information for trusted public key certificate import.
521
+ * Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
514
522
  */
515
- TrustedCertificatePublicKey?: TrustedCertificatePublicKey;
523
+ KeyCryptogram?: ImportKeyCryptogram;
516
524
  }
517
525
  export interface ImportKeyOutput {
518
526
  /**
@@ -522,24 +530,32 @@ declare namespace PaymentCryptography {
522
530
  }
523
531
  export type ImportTokenId = string;
524
532
  export interface ImportTr31KeyBlock {
525
- /**
526
- * The TR-31 wrapped key block to import.
527
- */
528
- WrappedKeyBlock: Tr31WrappedKeyBlock;
529
533
  /**
530
534
  * The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
531
535
  */
532
536
  WrappingKeyIdentifier: KeyArnOrKeyAliasType;
537
+ /**
538
+ * The TR-31 wrapped key block to import.
539
+ */
540
+ WrappedKeyBlock: Tr31WrappedKeyBlock;
533
541
  }
534
542
  export interface ImportTr34KeyBlock {
535
543
  /**
536
544
  * The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
537
545
  */
538
546
  CertificateAuthorityPublicKeyIdentifier: KeyArnOrKeyAliasType;
547
+ /**
548
+ * The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
549
+ */
550
+ SigningKeyCertificate: CertificateType;
539
551
  /**
540
552
  * 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.
541
553
  */
542
554
  ImportToken: ImportTokenId;
555
+ /**
556
+ * The TR-34 wrapped key block to import.
557
+ */
558
+ WrappedKeyBlock: Tr34WrappedKeyBlock;
543
559
  /**
544
560
  * The key block format to use during key import. The only value allowed is X9_TR34_2012.
545
561
  */
@@ -548,36 +564,8 @@ declare namespace PaymentCryptography {
548
564
  * 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.
549
565
  */
550
566
  RandomNonce?: HexLength16;
551
- /**
552
- * The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
553
- */
554
- SigningKeyCertificate: CertificateType;
555
- /**
556
- * The TR-34 wrapped key block to import.
557
- */
558
- WrappedKeyBlock: Tr34WrappedKeyBlock;
559
567
  }
560
568
  export interface Key {
561
- /**
562
- * The date and time when the key was created.
563
- */
564
- CreateTimestamp: Timestamp;
565
- /**
566
- * 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.
567
- */
568
- DeletePendingTimestamp?: Timestamp;
569
- /**
570
- * 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.
571
- */
572
- DeleteTimestamp?: Timestamp;
573
- /**
574
- * Specifies whether the key is enabled.
575
- */
576
- Enabled: Boolean;
577
- /**
578
- * Specifies whether the key is exportable. This data is immutable after the key is created.
579
- */
580
- Exportable: Boolean;
581
569
  /**
582
570
  * The Amazon Resource Name (ARN) of the key.
583
571
  */
@@ -595,13 +583,25 @@ declare namespace PaymentCryptography {
595
583
  */
596
584
  KeyCheckValueAlgorithm: KeyCheckValueAlgorithm;
597
585
  /**
598
- * 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.
586
+ * Specifies whether the key is enabled.
599
587
  */
600
- KeyOrigin: KeyOrigin;
588
+ Enabled: Boolean;
589
+ /**
590
+ * Specifies whether the key is exportable. This data is immutable after the key is created.
591
+ */
592
+ Exportable: Boolean;
601
593
  /**
602
594
  * The state of key that is being created or deleted.
603
595
  */
604
596
  KeyState: KeyState;
597
+ /**
598
+ * 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.
599
+ */
600
+ KeyOrigin: KeyOrigin;
601
+ /**
602
+ * The date and time when the key was created.
603
+ */
604
+ CreateTimestamp: Timestamp;
605
605
  /**
606
606
  * The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
607
607
  */
@@ -610,86 +610,106 @@ declare namespace PaymentCryptography {
610
610
  * The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
611
611
  */
612
612
  UsageStopTimestamp?: Timestamp;
613
+ /**
614
+ * 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.
615
+ */
616
+ DeletePendingTimestamp?: Timestamp;
617
+ /**
618
+ * 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.
619
+ */
620
+ DeleteTimestamp?: Timestamp;
613
621
  }
614
622
  export type KeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096"|string;
615
623
  export type KeyArn = string;
616
624
  export type KeyArnOrKeyAliasType = string;
617
625
  export interface KeyAttributes {
618
626
  /**
619
- * 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.
627
+ * The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
620
628
  */
621
- KeyAlgorithm: KeyAlgorithm;
629
+ KeyUsage: KeyUsage;
622
630
  /**
623
631
  * 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.
624
632
  */
625
633
  KeyClass: KeyClass;
634
+ /**
635
+ * 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.
636
+ */
637
+ KeyAlgorithm: KeyAlgorithm;
626
638
  /**
627
639
  * The list of cryptographic operations that you can perform using the key.
628
640
  */
629
641
  KeyModesOfUse: KeyModesOfUse;
642
+ }
643
+ export interface KeyBlockHeaders {
644
+ KeyModesOfUse?: KeyModesOfUse;
630
645
  /**
631
- * The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
646
+ * Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography. When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
632
647
  */
633
- KeyUsage: KeyUsage;
648
+ KeyExportability?: KeyExportability;
649
+ /**
650
+ * Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
651
+ */
652
+ KeyVersion?: KeyVersion;
653
+ /**
654
+ * Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks. Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
655
+ */
656
+ OptionalBlocks?: OptionalBlocks;
634
657
  }
635
658
  export type KeyCheckValue = string;
636
659
  export type KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"|string;
637
660
  export type KeyClass = "SYMMETRIC_KEY"|"ASYMMETRIC_KEY_PAIR"|"PRIVATE_KEY"|"PUBLIC_KEY"|string;
661
+ export type KeyExportability = "EXPORTABLE"|"NON_EXPORTABLE"|"SENSITIVE"|string;
638
662
  export type KeyMaterial = string;
639
663
  export type KeyMaterialType = "TR34_KEY_BLOCK"|"TR31_KEY_BLOCK"|"ROOT_PUBLIC_KEY_CERTIFICATE"|"TRUSTED_PUBLIC_KEY_CERTIFICATE"|"KEY_CRYPTOGRAM"|string;
640
664
  export interface KeyModesOfUse {
665
+ /**
666
+ * Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
667
+ */
668
+ Encrypt?: PrimitiveBoolean;
641
669
  /**
642
670
  * Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
643
671
  */
644
672
  Decrypt?: PrimitiveBoolean;
645
673
  /**
646
- * Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
674
+ * Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
647
675
  */
648
- DeriveKey?: PrimitiveBoolean;
676
+ Wrap?: PrimitiveBoolean;
649
677
  /**
650
- * Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
678
+ * Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
651
679
  */
652
- Encrypt?: PrimitiveBoolean;
680
+ Unwrap?: PrimitiveBoolean;
653
681
  /**
654
682
  * Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
655
683
  */
656
684
  Generate?: PrimitiveBoolean;
657
- /**
658
- * Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
659
- */
660
- NoRestrictions?: PrimitiveBoolean;
661
685
  /**
662
686
  * Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
663
687
  */
664
688
  Sign?: PrimitiveBoolean;
665
- /**
666
- * Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
667
- */
668
- Unwrap?: PrimitiveBoolean;
669
689
  /**
670
690
  * Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
671
691
  */
672
692
  Verify?: PrimitiveBoolean;
673
693
  /**
674
- * Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
694
+ * Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
675
695
  */
676
- Wrap?: PrimitiveBoolean;
696
+ DeriveKey?: PrimitiveBoolean;
697
+ /**
698
+ * Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
699
+ */
700
+ NoRestrictions?: PrimitiveBoolean;
677
701
  }
678
702
  export type KeyOrigin = "EXTERNAL"|"AWS_PAYMENT_CRYPTOGRAPHY"|string;
679
703
  export type KeyState = "CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_PENDING"|"DELETE_COMPLETE"|string;
680
704
  export interface KeySummary {
681
- /**
682
- * Specifies whether the key is enabled.
683
- */
684
- Enabled: Boolean;
685
- /**
686
- * Specifies whether the key is exportable. This data is immutable after the key is created.
687
- */
688
- Exportable: Boolean;
689
705
  /**
690
706
  * The Amazon Resource Name (ARN) of the key.
691
707
  */
692
708
  KeyArn: KeyArn;
709
+ /**
710
+ * The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
711
+ */
712
+ KeyState: KeyState;
693
713
  /**
694
714
  * 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.
695
715
  */
@@ -699,21 +719,26 @@ declare namespace PaymentCryptography {
699
719
  */
700
720
  KeyCheckValue: KeyCheckValue;
701
721
  /**
702
- * The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
722
+ * Specifies whether the key is exportable. This data is immutable after the key is created.
703
723
  */
704
- KeyState: KeyState;
724
+ Exportable: Boolean;
725
+ /**
726
+ * Specifies whether the key is enabled.
727
+ */
728
+ Enabled: Boolean;
705
729
  }
706
730
  export type KeySummaryList = KeySummary[];
707
731
  export type 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"|string;
732
+ export type KeyVersion = string;
708
733
  export interface ListAliasesInput {
709
- /**
710
- * 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.
711
- */
712
- MaxResults?: MaxResults;
713
734
  /**
714
735
  * 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.
715
736
  */
716
737
  NextToken?: NextToken;
738
+ /**
739
+ * 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.
740
+ */
741
+ MaxResults?: MaxResults;
717
742
  }
718
743
  export interface ListAliasesOutput {
719
744
  /**
@@ -730,14 +755,14 @@ declare namespace PaymentCryptography {
730
755
  * The key state of the keys you want to list.
731
756
  */
732
757
  KeyState?: KeyState;
733
- /**
734
- * 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.
735
- */
736
- MaxResults?: MaxResults;
737
758
  /**
738
759
  * 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.
739
760
  */
740
761
  NextToken?: NextToken;
762
+ /**
763
+ * 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.
764
+ */
765
+ MaxResults?: MaxResults;
741
766
  }
742
767
  export interface ListKeysOutput {
743
768
  /**
@@ -751,30 +776,33 @@ declare namespace PaymentCryptography {
751
776
  }
752
777
  export interface ListTagsForResourceInput {
753
778
  /**
754
- * 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.
779
+ * The KeyARN of the key whose tags you are getting.
755
780
  */
756
- MaxResults?: MaxResults;
781
+ ResourceArn: ResourceArn;
757
782
  /**
758
783
  * 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.
759
784
  */
760
785
  NextToken?: NextToken;
761
786
  /**
762
- * The KeyARN of the key whose tags you are getting.
787
+ * 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.
763
788
  */
764
- ResourceArn: ResourceArn;
789
+ MaxResults?: MaxResults;
765
790
  }
766
791
  export interface ListTagsForResourceOutput {
767
- /**
768
- * The token for the next set of results, or an empty or null value if there are no more results.
769
- */
770
- NextToken?: NextToken;
771
792
  /**
772
793
  * The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
773
794
  */
774
795
  Tags: Tags;
796
+ /**
797
+ * The token for the next set of results, or an empty or null value if there are no more results.
798
+ */
799
+ NextToken?: NextToken;
775
800
  }
776
801
  export type MaxResults = number;
777
802
  export type NextToken = string;
803
+ export type OptionalBlockId = string;
804
+ export type OptionalBlockValue = string;
805
+ export type OptionalBlocks = {[key: string]: OptionalBlockValue};
778
806
  export type PrimitiveBoolean = boolean;
779
807
  export type ResourceArn = string;
780
808
  export interface RestoreKeyInput {
@@ -854,10 +882,6 @@ declare namespace PaymentCryptography {
854
882
  export type Tr34KeyBlockFormat = "X9_TR34_2012"|string;
855
883
  export type Tr34WrappedKeyBlock = string;
856
884
  export interface TrustedCertificatePublicKey {
857
- /**
858
- * The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
859
- */
860
- CertificateAuthorityPublicKeyIdentifier: KeyArnOrKeyAliasType;
861
885
  /**
862
886
  * 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.
863
887
  */
@@ -866,6 +890,10 @@ declare namespace PaymentCryptography {
866
890
  * Parameter information for trusted public key certificate import.
867
891
  */
868
892
  PublicKeyCertificate: CertificateType;
893
+ /**
894
+ * The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
895
+ */
896
+ CertificateAuthorityPublicKeyIdentifier: KeyArnOrKeyAliasType;
869
897
  }
870
898
  export interface UntagResourceInput {
871
899
  /**
@@ -897,25 +925,25 @@ declare namespace PaymentCryptography {
897
925
  }
898
926
  export interface WrappedKey {
899
927
  /**
900
- * 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.
928
+ * The KeyARN of the wrapped key.
901
929
  */
902
- KeyCheckValue?: KeyCheckValue;
930
+ WrappingKeyArn: KeyArn;
903
931
  /**
904
- * 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.
932
+ * The key block format of a wrapped key.
905
933
  */
906
- KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
934
+ WrappedKeyMaterialFormat: WrappedKeyMaterialFormat;
907
935
  /**
908
936
  * Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
909
937
  */
910
938
  KeyMaterial: KeyMaterial;
911
939
  /**
912
- * The key block format of a wrapped key.
940
+ * 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.
913
941
  */
914
- WrappedKeyMaterialFormat: WrappedKeyMaterialFormat;
942
+ KeyCheckValue?: KeyCheckValue;
915
943
  /**
916
- * The KeyARN of the wrapped key.
944
+ * 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.
917
945
  */
918
- WrappingKeyArn: KeyArn;
946
+ KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
919
947
  }
920
948
  export type WrappedKeyCryptogram = string;
921
949
  export type WrappedKeyMaterialFormat = "KEY_CRYPTOGRAM"|"TR31_KEY_BLOCK"|"TR34_KEY_BLOCK"|string;