Enum pzip::KeyDerivation

pub enum KeyDerivation {
    Raw,
    HkdfSha256,
    Pbkdf2Sha256,
}

The key derivation functions (KDFs) known by PZip.

Encapsulates the tags needed for each KDF along with a common derive method.

Variants

Raw

HkdfSha256

Pbkdf2Sha256

Implementations

impl KeyDerivation

pub fn from(num: u8) -> Result<KeyDerivation, Error>

Returns a KeyDerivation for the specified u8 if known, otherwise Error::UnknownKeyDerivation.

pub fn tags(&self) -> PZipTags

Returns the PZipTags to be used for new PZip files using this key derivation.

Generally, this should return suitable random defaults for any derivation parameters. Specifically, for HKDF, this returns a Tag::Salt with a number of random bytes equal to the hash length. For PBKDF2, this returns a similar Tag::Salt as well as a Tag::Iterations specifying the number of PBKDF2 rounds.

pub fn derive(
    &self,
    material: &[u8],
    algorithm: Algorithm,
    tags: &PZipTags
) -> Result<Vec<u8>, Error>

Derives key bytes from input key material for the specified Algorithm, using parameters found in tags.

The number of bytes returned depends on the length of the key expected by the algorithm.

Trait Implementations

impl Clone for KeyDerivation

fn clone(&self) -> KeyDerivation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDerivation

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

Formats the value using the given formatter.

impl Hash for KeyDerivation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<KeyDerivation> for KeyDerivation

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

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

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

This method tests for !=.

impl Copy for KeyDerivation

impl Eq for KeyDerivation

impl StructuralEq for KeyDerivation

impl StructuralPartialEq for KeyDerivation