pub struct ExportKeyFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ExportKey
.
Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
You can use ExportKey
to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. 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
TR-34 key export
Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. 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 Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport
. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.
Set the following parameters:
- CertificateAuthorityPublicKeyIdentifier
-
The
KeyARN
of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by callingImportKey
forRootCertificatePublicKey
. - ExportToken
-
Obtained from KDH by calling
GetParametersForExport
. - WrappingKeyCertificate
-
Amazon Web Services Payment Cryptography uses this to wrap the key under export.
When this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block.
TR-31 key export
Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey
or ImportKey
. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
-
GetParametersForExport
-
ImportKey
Implementations§
source§impl ExportKeyFluentBuilder
impl ExportKeyFluentBuilder
sourcepub fn as_input(&self) -> &ExportKeyInputBuilder
pub fn as_input(&self) -> &ExportKeyInputBuilder
Access the ExportKey as a reference.
sourcepub async fn send(
self
) -> Result<ExportKeyOutput, SdkError<ExportKeyError, HttpResponse>>
pub async fn send( self ) -> Result<ExportKeyOutput, SdkError<ExportKeyError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<ExportKeyOutput, ExportKeyError, Self>, SdkError<ExportKeyError>>
pub async fn customize( self ) -> Result<CustomizableOperation<ExportKeyOutput, ExportKeyError, Self>, SdkError<ExportKeyError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn key_material(self, input: ExportKeyMaterial) -> Self
pub fn key_material(self, input: ExportKeyMaterial) -> Self
The key block format type, for example, TR-34 or TR-31, to use during key material export.
sourcepub fn set_key_material(self, input: Option<ExportKeyMaterial>) -> Self
pub fn set_key_material(self, input: Option<ExportKeyMaterial>) -> Self
The key block format type, for example, TR-34 or TR-31, to use during key material export.
sourcepub fn get_key_material(&self) -> &Option<ExportKeyMaterial>
pub fn get_key_material(&self) -> &Option<ExportKeyMaterial>
The key block format type, for example, TR-34 or TR-31, to use during key material export.
sourcepub fn export_key_identifier(self, input: impl Into<String>) -> Self
pub fn export_key_identifier(self, input: impl Into<String>) -> Self
The KeyARN
of the key under export from Amazon Web Services Payment Cryptography.
sourcepub fn set_export_key_identifier(self, input: Option<String>) -> Self
pub fn set_export_key_identifier(self, input: Option<String>) -> Self
The KeyARN
of the key under export from Amazon Web Services Payment Cryptography.
sourcepub fn get_export_key_identifier(&self) -> &Option<String>
pub fn get_export_key_identifier(&self) -> &Option<String>
The KeyARN
of the key under export from Amazon Web Services Payment Cryptography.
Trait Implementations§
source§impl Clone for ExportKeyFluentBuilder
impl Clone for ExportKeyFluentBuilder
source§fn clone(&self) -> ExportKeyFluentBuilder
fn clone(&self) -> ExportKeyFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more