Skip to main content

KdfParams

Struct KdfParams 

Source
pub struct KdfParams {
    pub m_cost_kib: u32,
    pub t_cost: u32,
    pub p_cost: u32,
}
Expand description

Argon2id parameters.

Parameters are stored inside every encrypted container so that defaults can evolve in the future without breaking older files. When parsing parameters from untrusted input they are validated against the bounds documented on each field to prevent denial-of-service via absurd values.

Fields§

§m_cost_kib: u32

Memory cost in KiB (Argon2 m). Default 65536 (64 MiB). Accepted range when reading untrusted input: 8 MiB ..= 4 GiB.

§t_cost: u32

Time cost — number of passes (Argon2 t). Default 4. Accepted range: 1 ..= 64.

§p_cost: u32

Degree of parallelism (Argon2 p). Default 4. Accepted range: 1 ..= 16.

Implementations§

Source§

impl KdfParams

Source

pub const fn new() -> Self

Library defaults: Argon2id with 64 MiB memory, 4 passes, parallelism 4 (matches the krypton CLI ≥ 0.2).

Source

pub fn read_from(buf: &[u8]) -> Result<Self>

Parses and validates parameters from a 12-byte little-endian encoding.

Source

pub fn validate(&self) -> Result<()>

Validates the parameters against safety bounds.

The upper bounds exist so that a hostile config file cannot make the process attempt an absurd allocation; the lower bound rejects settings so weak that no meaningful protection is provided.

Trait Implementations§

Source§

impl Clone for KdfParams

Source§

fn clone(&self) -> KdfParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for KdfParams

Source§

impl Debug for KdfParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KdfParams

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for KdfParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for KdfParams

Source§

impl PartialEq for KdfParams

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for KdfParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KdfParams

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.