Struct zff::header::version1::PBEHeader

pub struct PBEHeader { /* private fields */ }

The pbe header contains all informations for the encryption of the encryption key.
The encryption key, used for the chunk encryption, can be found at the EncryptionHeader - encrypted with an user password.
This encryption of the encryption key is done via a password-based encryption (PBE).
All metadata about this PBE can be found in this PBEHeader.\

Implementations

impl PBEHeader

pub fn new(
    version: u8,
    kdf_scheme: KDFScheme,
    encryption_scheme: PBEScheme,
    kdf_parameters: KDFParameters,
    pbencryption_nonce: [u8; 16]
) -> PBEHeader

returns a new pbe header with the given values.

pub fn kdf_scheme(&self) -> &KDFScheme

returns the kdf scheme.

pub fn encryption_scheme(&self) -> &PBEScheme

returns the encryption scheme.

pub fn kdf_parameters(&self) -> &KDFParameters

returns the kdf parameters.

pub fn nonce(&self) -> &[u8; 16]

returns the pbe nonce.

Trait Implementations

impl Clone for PBEHeader

fn clone(&self) -> PBEHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PBEHeader

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

Formats the value using the given formatter.

impl HeaderCoding for PBEHeader

type Item = PBEHeader

the return value for decode_content(), decode_directly(), decode_for_key();

fn identifier() -> u32

returns the identifier (=Magic bytes) of the header.

fn version(&self) -> u8

returns the version of the header.

fn encode_header(&self) -> Vec<u8>

encodes the header.

fn decode_content(data: Vec<u8>) -> Result<PBEHeader>

decodes the content of the header.

fn header_size(&self) -> usize

returns the size of the encoded header (in bytes)

fn encode_key<K: Into<String>>(key: K) -> Vec<u8>

encodes a given key.

fn encode_directly(&self) -> Vec<u8>

encodes the (header) value/object directly (= without key).

fn encode_for_key<K: Into<String>>(&self, key: K) -> Vec<u8>

encodes a key to the (header) value/object.

fn decode_header_length<R: Read>(data: &mut R) -> Result<u64>

decodes the length of the header.

fn check_identifier<R: Read>(data: &mut R) -> bool

checks if the read identifier is valid for this header.

fn check_key_on_position<K: Into<String>, R: Read>(data: &mut R, key: K) -> bool

helper method to check, if the key is on position.

fn decode_directly<R: Read>(data: &mut R) -> Result<Self::Item>

decodes the header directly.

fn decode_for_key<K: Into<String>, R: Read>(
    data: &mut R,
    key: K
) -> Result<Self::Item>

decodes the header for the given key.

impl PartialEq<PBEHeader> for PBEHeader

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for PBEHeader

impl StructuralEq for PBEHeader

impl StructuralPartialEq for PBEHeader