Enum ssh_key::Kdf

#[non_exhaustive]
pub enum Kdf {
    None,
    Bcrypt {
        salt: Vec<u8>,
        rounds: u32,
    },
}

Key Derivation Functions (KDF).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

No KDF.

Bcrypt

Fields

salt: Vec<u8>

Salt

rounds: u32

Rounds

Available on crate feature alloc only.

bcrypt-pbkdf options.

Implementations

impl Kdf

pub fn new(algorithm: KdfAlg, rng: impl CryptoRng + RngCore) -> Result<Self>

Available on crate feature encryption only.

Initialize KDF configuration for the given algorithm.

pub fn algorithm(&self) -> KdfAlg

Get the KDF algorithm.

pub fn derive(&self, password: impl AsRef<[u8]>, output: &mut [u8]) -> Result<()>

Available on crate feature encryption only.

Derive an encryption key from the given password.

pub fn derive_key_and_iv(
    &self,
    cipher: Cipher,
    password: impl AsRef<[u8]>
) -> Result<(Zeroizing<Vec<u8>>, Vec<u8>)>

Available on crate feature encryption only.

Derive key and IV for the given Cipher.

Returns two byte vectors containing the key and IV respectively.

pub fn is_none(&self) -> bool

Is the KDF configured as none?

pub fn is_some(&self) -> bool

Is the KDF configured as anything other than none?

pub fn is_bcrypt(&self) -> bool

Available on crate feature alloc only.

Is the KDF configured as bcrypt (i.e. bcrypt-pbkdf)?

Trait Implementations

impl Clone for Kdf

fn clone(&self) -> Kdf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kdf

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

Formats the value using the given formatter.

impl Decode for Kdf

type Error = Error

Type returned in the event of a decoding error.

fn decode(reader: &mut impl Reader) -> Result<Self>

Attempt to decode a value of this type using the provided Reader.

impl Default for Kdf

fn default() -> Self

Returns the “default value” for a type.

impl Encode for Kdf

type Error = Error

Type returned in the event of an encoding error.

fn encoded_len(&self) -> Result<usize>

Get the length of this type encoded in bytes, prior to Base64 encoding.

fn encode(&self, writer: &mut impl Writer) -> Result<()>

Encode this value using the provided Writer.

fn encoded_len_prefixed(&self) -> Result<usize, Self::Error>

Return the length of this type after encoding when prepended with a uint32 length prefix.

fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error>

Encode this value, first prepending a uint32 length prefix set to Encode::encoded_len.

impl PartialEq<Kdf> for Kdf

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Kdf

impl StructuralEq for Kdf

impl StructuralPartialEq for Kdf