Struct Header 

pub struct Header {
    pub version: u8,
    pub suite: u8,
    pub flags: u8,
    pub key_id: [u8; 8],
}

The parsed header of an encrypted file.

Fields

version: u8

Format version; only FORMAT_VERSION is accepted today.

suite: u8

Cipher suite; only SUITE_AES_256_SIV is accepted today.

flags: u8

Conversion flags recorded at encryption time.

key_id: [u8; 8]

Fingerprint of the master key this file was encrypted with.

Implementations

impl Header

pub fn new(flags: u8, key_id: [u8; 8]) -> Self

Builds a header for the suite and version we write today.

pub fn to_bytes(self) -> [u8; 22]

Serialises the header exactly as it appears at the start of a file.

pub fn parse(blob: &[u8]) -> Result<Self>

Parses the header at the start of blob, refusing anything unknown.

Fail closed is the rule here: an older binary meeting a newer file must stop rather than guess. That covers an unknown format version, an unknown suite and any reserved flag bit being set.

Errors

Error::Format when the blob is too short, lacks the magic, or names a version, suite or flag bit this build does not understand.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq for Header

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Header