@aws-sdk/client-payment-cryptography 3.465.0 → 3.468.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist-types/PaymentCryptography.d.ts +3 -3
- package/dist-types/PaymentCryptographyClient.d.ts +3 -3
- package/dist-types/commands/CreateKeyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKeyCommand.d.ts +2 -3
- package/dist-types/commands/ExportKeyCommand.d.ts +62 -22
- package/dist-types/commands/GetParametersForImportCommand.d.ts +2 -2
- package/dist-types/commands/ImportKeyCommand.d.ts +31 -20
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +233 -184
- package/dist-types/ts3.4/models/models_0.d.ts +49 -39
- package/package.json +34 -34
package/README.md
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript PaymentCryptography Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>
|
|
9
|
+
<p>Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html">Identity and access management</a> in the <i>Amazon Web Services Payment Cryptography User Guide.</i>
|
|
10
10
|
</p>
|
|
11
|
-
<p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can encrypt, decrypt, generate,
|
|
11
|
+
<p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.</p>
|
|
12
12
|
<p>All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests. </p>
|
|
13
|
-
<p>Amazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket
|
|
13
|
+
<p>Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
14
14
|
|
|
15
15
|
## Installing
|
|
16
16
|
|
|
@@ -144,11 +144,11 @@ export interface PaymentCryptography {
|
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
146
|
* @public
|
|
147
|
-
* <p>
|
|
147
|
+
* <p>Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html">Identity and access management</a> in the <i>Amazon Web Services Payment Cryptography User Guide.</i>
|
|
148
148
|
* </p>
|
|
149
|
-
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can encrypt, decrypt, generate,
|
|
149
|
+
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.</p>
|
|
150
150
|
* <p>All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests. </p>
|
|
151
|
-
* <p>Amazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket
|
|
151
|
+
* <p>Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
152
152
|
*/
|
|
153
153
|
export declare class PaymentCryptography extends PaymentCryptographyClient implements PaymentCryptography {
|
|
154
154
|
}
|
|
@@ -172,11 +172,11 @@ export interface PaymentCryptographyClientResolvedConfig extends PaymentCryptogr
|
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
174
|
* @public
|
|
175
|
-
* <p>
|
|
175
|
+
* <p>Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html">Identity and access management</a> in the <i>Amazon Web Services Payment Cryptography User Guide.</i>
|
|
176
176
|
* </p>
|
|
177
|
-
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can encrypt, decrypt, generate,
|
|
177
|
+
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.</p>
|
|
178
178
|
* <p>All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests. </p>
|
|
179
|
-
* <p>Amazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket
|
|
179
|
+
* <p>Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
180
180
|
*/
|
|
181
181
|
export declare class PaymentCryptographyClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PaymentCryptographyClientResolvedConfig> {
|
|
182
182
|
/**
|
|
@@ -25,7 +25,7 @@ export interface CreateKeyCommandOutput extends CreateKeyOutput, __MetadataBeare
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>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. </p>
|
|
27
27
|
* <p>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.</p>
|
|
28
|
-
* <p>When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that
|
|
28
|
+
* <p>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: <code>SYMMETRIC_KEY</code>), key algorithm (example: <code>TDES_2KEY</code>), key usage (example: <code>TR31_P0_PIN_ENCRYPTION_KEY</code>) and key modes of use (example: <code>Encrypt</code>). For information about valid combinations of key attributes, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html">Understanding key attributes</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.</p>
|
|
29
29
|
* <p>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. </p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p>
|
|
@@ -23,9 +23,8 @@ export interface DeleteKeyCommandOutput extends DeleteKeyOutput, __MetadataBeare
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes the key material and
|
|
27
|
-
* <p>Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period
|
|
28
|
-
* <p>If you delete key material, you can use <a>ImportKey</a> to reimport the same key material into the Amazon Web Services Payment Cryptography key.</p>
|
|
26
|
+
* <p>Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.</p>
|
|
27
|
+
* <p>Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using <code>DeleteKeyInDays</code>. The default waiting period is 7 days. During the waiting period, the <code>KeyState</code> is <code>DELETE_PENDING</code>. After the key is deleted, the <code>KeyState</code> is <code>DELETE_COMPLETE</code>.</p>
|
|
29
28
|
* <p>You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling <a>StopKeyUsage</a>.</p>
|
|
30
29
|
* <p>
|
|
31
30
|
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
|
|
@@ -23,33 +23,65 @@ export interface ExportKeyCommandOutput extends ExportKeyOutput, __MetadataBeare
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Exports a key from Amazon Web Services Payment Cryptography
|
|
27
|
-
* <p>Amazon Web Services Payment Cryptography simplifies
|
|
28
|
-
* <p>
|
|
26
|
+
* <p>Exports a key from Amazon Web Services Payment Cryptography.</p>
|
|
27
|
+
* <p>Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With <code>ExportKey</code> 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 </p>
|
|
28
|
+
* <p>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 . 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.</p>
|
|
29
|
+
* <p>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.</p>
|
|
30
|
+
* <p>You can also use <code>ExportKey</code> 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 <code>ExportDukptInitialKey</code> attribute KSN (<code>KeySerialNumber</code>). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.</p>
|
|
29
31
|
* <p>
|
|
30
|
-
* <b>TR-34
|
|
32
|
+
* <b>To export KEK or IPEK using TR-34</b>
|
|
31
33
|
* </p>
|
|
32
|
-
* <p>
|
|
34
|
+
* <p>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.</p>
|
|
35
|
+
* <p>To initiate TR-34 key export, the KRD must obtain an export token by calling <a>GetParametersForExport</a>. 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. </p>
|
|
36
|
+
* <p>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 <a>ImportKey</a> for <code>RootCertificatePublicKey</code>. 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 <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html">Exporting symmetric keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p>
|
|
33
37
|
* <p>Set the following parameters:</p>
|
|
34
|
-
* <
|
|
35
|
-
* <
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* </
|
|
39
|
-
* <
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* </
|
|
43
|
-
* <
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* </
|
|
47
|
-
*
|
|
48
|
-
*
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <code>ExportAttributes</code>: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>
|
|
45
|
+
* <code>ExportKeyIdentifier</code>: The <code>KeyARN</code> of the KEK or BDK (in case of IPEK) under export.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <code>KeyMaterial</code>: Use <code>Tr34KeyBlock</code> parameters.</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>
|
|
53
|
+
* <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>KeyARN</code> of the certificate chain that signed the KRD wrapping key certificate.</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>
|
|
57
|
+
* <code>ExportToken</code>: Obtained from KDH by calling <a>GetParametersForImport</a>.</p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
61
|
+
* <code>WrappingKeyCertificate</code>: 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.</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* </ul>
|
|
64
|
+
* <p>When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock. </p>
|
|
49
65
|
* <p>
|
|
50
|
-
* <b>TR-31
|
|
66
|
+
* <b>To export WK (Working Key) or IPEK using TR-31</b>
|
|
51
67
|
* </p>
|
|
52
|
-
* <p>
|
|
68
|
+
* <p>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 <a>CreateKey</a> or <a>ImportKey</a>. </p>
|
|
69
|
+
* <p>Set the following parameters:</p>
|
|
70
|
+
* <ul>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>
|
|
73
|
+
* <code>ExportAttributes</code>: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>
|
|
77
|
+
* <code>ExportKeyIdentifier</code>: The <code>KeyARN</code> of the KEK or BDK (in case of IPEK) under export.</p>
|
|
78
|
+
* </li>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>
|
|
81
|
+
* <code>KeyMaterial</code>: Use <code>Tr31KeyBlock</code> parameters.</p>
|
|
82
|
+
* </li>
|
|
83
|
+
* </ul>
|
|
84
|
+
* <p>When this operation is successful, Amazon Web Services Payment Cryptography returns the WK or IPEK as a TR-31 WrappedKeyBlock.</p>
|
|
53
85
|
* <p>
|
|
54
86
|
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
|
|
55
87
|
* <p>
|
|
@@ -87,6 +119,12 @@ export interface ExportKeyCommandOutput extends ExportKeyOutput, __MetadataBeare
|
|
|
87
119
|
* },
|
|
88
120
|
* },
|
|
89
121
|
* ExportKeyIdentifier: "STRING_VALUE", // required
|
|
122
|
+
* ExportAttributes: { // ExportAttributes
|
|
123
|
+
* ExportDukptInitialKey: { // ExportDukptInitialKey
|
|
124
|
+
* KeySerialNumber: "STRING_VALUE", // required
|
|
125
|
+
* },
|
|
126
|
+
* KeyCheckValueAlgorithm: "STRING_VALUE",
|
|
127
|
+
* },
|
|
90
128
|
* };
|
|
91
129
|
* const command = new ExportKeyCommand(input);
|
|
92
130
|
* const response = await client.send(command);
|
|
@@ -95,6 +133,8 @@ export interface ExportKeyCommandOutput extends ExportKeyOutput, __MetadataBeare
|
|
|
95
133
|
* // WrappingKeyArn: "STRING_VALUE", // required
|
|
96
134
|
* // WrappedKeyMaterialFormat: "STRING_VALUE", // required
|
|
97
135
|
* // KeyMaterial: "STRING_VALUE", // required
|
|
136
|
+
* // KeyCheckValue: "STRING_VALUE",
|
|
137
|
+
* // KeyCheckValueAlgorithm: "STRING_VALUE",
|
|
98
138
|
* // },
|
|
99
139
|
* // };
|
|
100
140
|
*
|
|
@@ -23,8 +23,8 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets the import token and the wrapping key certificate to initiate a TR-34
|
|
27
|
-
* <p>The wrapping key certificate wraps the key under import
|
|
26
|
+
* <p>Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock.</p>
|
|
27
|
+
* <p>The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling <a>ImportKey</a>. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.</p>
|
|
28
28
|
* <p>
|
|
29
29
|
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
|
|
30
30
|
* <p>
|
|
@@ -23,15 +23,19 @@ export interface ImportKeyCommandOutput extends ImportKeyOutput, __MetadataBeare
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Imports keys and public key certificates into Amazon Web Services Payment Cryptography.</p>
|
|
27
|
-
* <p>Amazon Web Services Payment Cryptography simplifies
|
|
28
|
-
* <p>
|
|
29
|
-
* <p>
|
|
30
|
-
* <p>You can also import a <i>root public key certificate</i>,
|
|
26
|
+
* <p>Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.</p>
|
|
27
|
+
* <p>Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With <code>ImportKey</code> you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.</p>
|
|
28
|
+
* <p>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 . 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.</p>
|
|
29
|
+
* <p>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. </p>
|
|
30
|
+
* <p>You can also import a <i>root public key certificate</i>, used to sign other public key certificates, or a <i>trusted public key certificate</i> under an already established root public key certificate.</p>
|
|
31
31
|
* <p>
|
|
32
32
|
* <b>To import a public root key certificate</b>
|
|
33
33
|
* </p>
|
|
34
|
-
* <p>
|
|
34
|
+
* <p>You can also import a <i>root public key certificate</i>, used to sign other public key certificates, or a <i>trusted public key certificate</i> under an already established root public key certificate.</p>
|
|
35
|
+
* <p>
|
|
36
|
+
* <b>To import a public root key certificate</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <p>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.</p>
|
|
35
39
|
* <p>Set the following parameters:</p>
|
|
36
40
|
* <ul>
|
|
37
41
|
* <li>
|
|
@@ -56,7 +60,7 @@ export interface ImportKeyCommandOutput extends ImportKeyOutput, __MetadataBeare
|
|
|
56
60
|
* </li>
|
|
57
61
|
* <li>
|
|
58
62
|
* <p>
|
|
59
|
-
* <code>PublicKeyCertificate</code>: The certificate
|
|
63
|
+
* <code>PublicKeyCertificate</code>: The public key certificate in PEM format (base64 encoded) of the private root key under import.</p>
|
|
60
64
|
* </li>
|
|
61
65
|
* </ul>
|
|
62
66
|
* <p>
|
|
@@ -79,43 +83,50 @@ export interface ImportKeyCommandOutput extends ImportKeyOutput, __MetadataBeare
|
|
|
79
83
|
* </li>
|
|
80
84
|
* <li>
|
|
81
85
|
* <p>
|
|
82
|
-
* <code>PublicKeyCertificate</code>: The
|
|
86
|
+
* <code>PublicKeyCertificate</code>: The trusted public key certificate in PEM format (base64 encoded) under import.</p>
|
|
83
87
|
* </li>
|
|
84
88
|
* </ul>
|
|
85
89
|
* <p>
|
|
86
|
-
* <b>
|
|
90
|
+
* <b>To import KEK or ZMK using TR-34</b>
|
|
87
91
|
* </p>
|
|
88
|
-
* <p>
|
|
92
|
+
* <p>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.</p>
|
|
93
|
+
* <p>To initiate TR-34 key import, the KDH must obtain an import token by calling <a>GetParametersForImport</a>. 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.</p>
|
|
94
|
+
* <p>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 <code>ImportKey</code> for <code>RootCertificatePublicKey</code>. For more information on TR-34 key import, see section <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html">Importing symmetric keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
|
|
89
95
|
* <p>Set the following parameters:</p>
|
|
90
96
|
* <ul>
|
|
91
97
|
* <li>
|
|
92
98
|
* <p>
|
|
93
|
-
* <code>
|
|
99
|
+
* <code>KeyMaterial</code>: Use <code>Tr34KeyBlock</code> parameters.</p>
|
|
94
100
|
* </li>
|
|
95
101
|
* <li>
|
|
96
102
|
* <p>
|
|
97
|
-
* <code>
|
|
103
|
+
* <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>KeyARN</code> of the certificate chain that signed the KDH signing key certificate.</p>
|
|
98
104
|
* </li>
|
|
99
105
|
* <li>
|
|
100
106
|
* <p>
|
|
101
|
-
* <code>
|
|
107
|
+
* <code>ImportToken</code>: Obtained from KRD by calling <a>GetParametersForImport</a>.</p>
|
|
102
108
|
* </li>
|
|
103
109
|
* <li>
|
|
104
110
|
* <p>
|
|
105
|
-
* <code>
|
|
111
|
+
* <code>WrappedKeyBlock</code>: 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.</p>
|
|
112
|
+
* </li>
|
|
113
|
+
* <li>
|
|
114
|
+
* <p>
|
|
115
|
+
* <code>SigningKeyCertificate</code>: 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.</p>
|
|
106
116
|
* </li>
|
|
107
117
|
* </ul>
|
|
108
|
-
* <note>
|
|
109
|
-
* <p>TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.</p>
|
|
110
|
-
* </note>
|
|
111
118
|
* <p>
|
|
112
|
-
* <b>
|
|
119
|
+
* <b>To import WK (Working Key) using TR-31</b>
|
|
113
120
|
* </p>
|
|
114
|
-
* <p>Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange
|
|
121
|
+
* <p>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 <a>CreateKey</a>. To initiate a TR-31 key import, set the following parameters:</p>
|
|
115
122
|
* <ul>
|
|
116
123
|
* <li>
|
|
117
124
|
* <p>
|
|
118
|
-
* <code>
|
|
125
|
+
* <code>KeyMaterial</code>: Use <code>Tr31KeyBlock</code> parameters.</p>
|
|
126
|
+
* </li>
|
|
127
|
+
* <li>
|
|
128
|
+
* <p>
|
|
129
|
+
* <code>WrappedKeyBlock</code>: 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. </p>
|
|
119
130
|
* </li>
|
|
120
131
|
* <li>
|
|
121
132
|
* <p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>
|
|
2
|
+
* <p>Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html">Identity and access management</a> in the <i>Amazon Web Services Payment Cryptography User Guide.</i>
|
|
3
3
|
* </p>
|
|
4
|
-
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can encrypt, decrypt, generate,
|
|
4
|
+
* <p>To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html">Amazon Web Services Payment Cryptography Data Plane</a>. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.</p>
|
|
5
5
|
* <p>All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests. </p>
|
|
6
|
-
* <p>Amazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket
|
|
6
|
+
* <p>Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
7
7
|
*
|
|
8
8
|
* @packageDocumentation
|
|
9
9
|
*/
|