Struct EncryptionHeader 

pub struct EncryptionHeader { /* private fields */ }

The encryption header contains all informations (and the encrypted key) for the data and header encryption.
The encryption header is the only optional header part of the main header (With the exception of the PBEHeader, which is, however, part of the EncryptionHeader). The encryption header contains an encrypted key (encrypted encryption key). This key is encrypted with a password based encryption method, described by the containing PBEHeader. This key (decrypted with the appropriate password) is used to decrypt the encrypted data or the optionally encrypted header.

Implementations

impl EncryptionHeader

pub fn new( version: u8, pbe_header: PBEHeader, algorithm: EncryptionAlgorithm, encrypted_encryption_key: Vec<u8>, encrypted_header_nonce: [u8; 12], ) -> EncryptionHeader

creates a new encryption header by the given values.

pub fn algorithm(&self) -> &EncryptionAlgorithm

returns the used encryption algorithm as a reference.

pub fn pbe_header(&self) -> &PBEHeader

returns a reference to the inner PBE header.

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

returns the nonce, used for header encryption. Note: this nonce is only used for the optionally header encryption.

pub fn decrypt_encryption_key<P: AsRef<[u8]>>( &self, password: P, ) -> Result<Vec<u8>>

tries to decrypt the encryption key.

Trait Implementations

impl Clone for EncryptionHeader

fn clone(&self) -> EncryptionHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptionHeader

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

Formats the value using the given formatter.

impl HeaderCoding for EncryptionHeader

type Item = EncryptionHeader

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<EncryptionHeader>

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 for EncryptionHeader

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

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

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 Eq for EncryptionHeader

impl StructuralPartialEq for EncryptionHeader