Enum ssh_key::Kdf

source · [−]

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

Expand description

Key Derivation Functions (KDF).

Variants (Non-exhaustive)

This enum is marked as 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

source

impl Kdf

source

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

Available on crate feature encryption only.

Initialize KDF configuration for the given algorithm.

source

pub fn algorithm(&self) -> KdfAlg

Get the KDF algorithm.

source

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.

source

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.

source

pub fn is_none(&self) -> bool

Is the KDF configured as none?

source

pub fn is_some(&self) -> bool

Is the KDF configured as anything other than none?

source

pub fn is_bcrypt(&self) -> bool

Available on crate feature alloc only.

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

Trait Implementations

source

impl Clone for Kdf

source

fn clone(&self) -> Kdf

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Kdf

source

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

Formats the value using the given formatter. Read more

source

impl Default for Kdf

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl PartialEq<Kdf> for Kdf

source

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

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

source

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

This method tests for !=.

source

impl Eq for Kdf

source

impl StructuralEq for Kdf

source

impl StructuralPartialEq for Kdf

Auto Trait Implementations

impl RefUnwindSafe for Kdf

impl Send for Kdf

impl Sync for Kdf

impl Unpin for Kdf

impl UnwindSafe for Kdf

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum ssh_key::Kdf

Variants (Non-exhaustive)

None

Bcrypt

Fields

Implementations

impl Kdf

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

pub fn algorithm(&self) -> KdfAlg

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

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

pub fn is_none(&self) -> bool

pub fn is_some(&self) -> bool

pub fn is_bcrypt(&self) -> bool

Trait Implementations

impl Clone for Kdf

fn clone(&self) -> Kdf

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

impl Debug for Kdf

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

impl Default for Kdf

fn default() -> Self

impl PartialEq<Kdf> for Kdf

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

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

impl Eq for Kdf

impl StructuralEq for Kdf

impl StructuralPartialEq for Kdf

Auto Trait Implementations

impl RefUnwindSafe for Kdf

impl Send for Kdf

impl Sync for Kdf

impl Unpin for Kdf

impl UnwindSafe for Kdf

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

`None`

`Bcrypt`

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,