Struct KeyBlockHeaders

#[non_exhaustive]
pub struct KeyBlockHeaders {
    pub key_modes_of_use: Option<KeyModesOfUse>,
    pub key_exportability: Option<KeyExportability>,
    pub key_version: Option<String>,
    pub optional_blocks: Option<HashMap<String, String>>,
}

Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_modes_of_use: 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.

key_exportability: 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.

key_version: 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.

optional_blocks: 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.

Implementations

impl KeyBlockHeaders

pub fn 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) -> 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) -> Option<&str>

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) -> 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.

impl KeyBlockHeaders

pub fn builder() -> KeyBlockHeadersBuilder

Creates a new builder-style object to manufacture KeyBlockHeaders.

Trait Implementations

impl Clone for KeyBlockHeaders

fn clone(&self) -> KeyBlockHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBlockHeaders

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

Formats the value using the given formatter.

impl PartialEq for KeyBlockHeaders

fn eq(&self, other: &KeyBlockHeaders) -> 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 KeyBlockHeaders