Struct KeyBlockHeadersBuilder

#[non_exhaustive]
pub struct KeyBlockHeadersBuilder { /* private fields */ }

A builder for KeyBlockHeaders.

Implementations

impl KeyBlockHeadersBuilder

pub fn key_modes_of_use(self, input: KeyModesOfUse) -> Self

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

pub fn set_key_modes_of_use(self, input: Option<KeyModesOfUse>) -> Self

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

pub fn get_key_modes_of_use(&self) -> &Option<KeyModesOfUse>

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

pub fn key_exportability(self, input: KeyExportability) -> Self

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.

pub fn set_key_exportability(self, input: Option<KeyExportability>) -> Self

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.

pub fn get_key_exportability(&self) -> &Option<KeyExportability>

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.

pub fn key_version(self, input: impl Into<String>) -> Self

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.

pub fn set_key_version(self, input: Option<String>) -> Self

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.

pub fn get_key_version(&self) -> &Option<String>

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.

pub fn optional_blocks(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to optional_blocks.

To override the contents of this collection use set_optional_blocks.

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.

pub fn set_optional_blocks(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_optional_blocks(&self) -> &Option<HashMap<String, String>>

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.

pub fn build(self) -> KeyBlockHeaders

Consumes the builder and constructs a KeyBlockHeaders.

Trait Implementations

impl Clone for KeyBlockHeadersBuilder

fn clone(&self) -> KeyBlockHeadersBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyBlockHeadersBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KeyBlockHeadersBuilder

fn default() -> KeyBlockHeadersBuilder

Returns the “default value” for a type.

impl PartialEq for KeyBlockHeadersBuilder

fn eq(&self, other: &KeyBlockHeadersBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KeyBlockHeadersBuilder