Struct KeyBlockHeader 

pub struct KeyBlockHeader { /* private fields */ }

Represents a TR-31 key block header.

Implementations

impl KeyBlockHeader

pub fn new_empty() -> Self

Create a new empty key block header.

pub fn new_with_values( version_id: &str, key_usage: &str, algorithm: &str, mode_of_use: &str, key_version_number: &str, exportability: &str, ) -> Result<Self, KeyBlockHeaderError>

Create a new key block header from individual header values.

pub fn new_from_str(header_str: &str) -> Result<Self, KeyBlockHeaderError>

Parse a key block header from its string representation.

The input may contain additional key block data after the header. Optional blocks are parsed according to the number declared in the fixed header.

pub fn export_str(&self) -> Result<String, KeyBlockHeaderError>

Export the key block header to its ASCII representation.

pub fn set_version_id(&mut self, value: &str) -> Result<(), KeyBlockHeaderError>

Set the key block version identifier.

pub fn version_id(&self) -> &str

Return the key block version identifier.

pub fn set_kb_length(&mut self, value: u16) -> Result<(), KeyBlockHeaderError>

Set the complete key block length.

pub fn kb_length(&self) -> u16

Return the complete key block length.

pub fn set_key_usage(&mut self, value: &str) -> Result<(), KeyBlockHeaderError>

Set the key usage.

pub fn key_usage(&self) -> &str

Return the key usage.

pub fn set_algorithm(&mut self, value: &str) -> Result<(), KeyBlockHeaderError>

Set the protected-key algorithm.

pub fn algorithm(&self) -> &str

Return the protected-key algorithm.

pub fn set_mode_of_use( &mut self, value: &str, ) -> Result<(), KeyBlockHeaderError>

Set the key mode of use.

pub fn mode_of_use(&self) -> &str

Return the key mode of use.

pub fn set_key_version_number( &mut self, value: &str, ) -> Result<(), KeyBlockHeaderError>

Set the key version number.

pub fn key_version_number(&self) -> &str

Return the key version number.

pub fn set_exportability( &mut self, value: &str, ) -> Result<(), KeyBlockHeaderError>

Set the exportability attribute.

pub fn exportability(&self) -> &str

Return the exportability attribute.

pub fn set_num_optional_blocks( &mut self, value: u8, ) -> Result<(), KeyBlockHeaderError>

Set the number of optional blocks declared in the header.

pub fn num_optional_blocks(&self) -> u8

Return the number of optional blocks declared in the header.

pub fn set_reserved_field( &mut self, value: &str, ) -> Result<(), KeyBlockHeaderError>

Set the TR-31 reserved header field.

pub fn reserved_field(&self) -> &str

Return the reserved header field.

pub fn set_opt_blocks(&mut self, opt_blocks: Option<Box<OptBlock>>)

Replace the linked optional blocks and update their count.

pub fn append_opt_blocks(&mut self, opt_block_to_append: OptBlock)

Append one or more optional blocks to the existing optional-block chain.

pub fn opt_blocks(&self) -> &Option<Box<OptBlock>>

Return the optional-block chain.

pub fn len(&self) -> usize

Return the complete encoded header length, including optional blocks.

pub fn finalize(&mut self) -> Result<(), KeyBlockHeaderError>

Finalize the header by padding optional blocks to the cipher block boundary when required.

Trait Implementations

impl Debug for KeyBlockHeader

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

Formats the value using the given formatter.

impl PartialEq for KeyBlockHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyBlockHeader