Struct argon2::Params

source · [−]

pub struct Params { /* private fields */ }

Expand description

Argon2 password hash parameters.

These are parameters which can be encoded into a PHC hash string.

Implementations

impl Params

pub const DEFAULT_M_COST: u32 = 4_096u32

Default memory cost.

pub const MIN_M_COST: u32 = 8u32

Minimum number of memory blocks.

pub const MAX_M_COST: u32 = 268_435_455u32

Maximum number of memory blocks.

pub const DEFAULT_T_COST: u32 = 3u32

Default number of iterations (i.e. “time”).

pub const MIN_T_COST: u32 = 1u32

Minimum number of passes.

pub const MAX_T_COST: u32 = 4_294_967_295u32

Maximum number of passes.

pub const DEFAULT_P_COST: u32 = 1u32

Default degree of parallelism.

pub const MIN_P_COST: u32 = 1u32

Minimum and maximum number of threads (i.e. parallelism).

pub const MAX_P_COST: u32 = 16_777_215u32

Minimum and maximum number of threads (i.e. parallelism).

pub const MAX_KEYID_LEN: usize = 8usize

Maximum length of a key ID in bytes.

pub const MAX_DATA_LEN: usize = 32usize

Maximum length of associated data in bytes.

pub const DEFAULT_OUTPUT_LEN: usize = 32usize

Default output length.

pub const MIN_OUTPUT_LEN: usize = 4usize

Minimum digest size in bytes.

pub const MAX_OUTPUT_LEN: usize = 4_294_967_295usize

Maximum digest size in bytes.

pub fn new(
    m_cost: u32,
    t_cost: u32,
    p_cost: u32,
    output_len: Option<usize>
) -> Result<Self>

Create new parameters.

pub fn m_cost(&self) -> u32

Memory size, expressed in kilobytes, between 1 and (2^32)-1.

Value is an integer in decimal (1 to 10 digits).

pub fn t_cost(&self) -> u32

Number of iterations, between 1 and (2^32)-1.

Value is an integer in decimal (1 to 10 digits).

pub fn p_cost(&self) -> u32

Degree of parallelism, between 1 and 255.

Value is an integer in decimal (1 to 3 digits).

pub fn keyid(&self) -> &[u8]ⓘNotable traits for &mut [u8]`impl<'_> Write for &mut [u8]impl<'_> Read for &[u8]`

Key identifier: byte slice between 0 and 8 bytes in length.

Defaults to an empty byte slice.

Note this field is only present as a helper for reading/storing in the PHC hash string format (i.e. it is totally ignored from a cryptographical standpoint).

On top of that, this field is not longer part of the argon2 standard (see: https://github.com/P-H-C/phc-winner-argon2/pull/173), and should not be used for any non-legacy work.

pub fn data(&self) -> &[u8]ⓘNotable traits for &mut [u8]`impl<'_> Write for &mut [u8]impl<'_> Read for &[u8]`

Associated data: byte slice between 0 and 32 bytes in length.

Defaults to an empty byte slice.

This field is not longer part of the argon2 standard (see: https://github.com/P-H-C/phc-winner-argon2/pull/173), and should not be used for any non-legacy work.

pub fn output_len(&self) -> Option<usize>

Length of the output (in bytes).

pub fn block_count(&self) -> usize

Get the number of blocks required given the configured m_cost and p_cost.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

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

impl Debug for Params

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

Formats the value using the given formatter. Read more

impl Default for Params

fn default() -> Params

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

impl<'key> From<&Params> for Argon2<'key>

fn from(params: &Params) -> Self

Converts to this type from the input type.

impl<'key> From<Params> for Argon2<'key>

fn from(params: Params) -> Self

Converts to this type from the input type.

impl PartialEq<Params> for Params

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

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

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

This method tests for !=.

impl<'a> TryFrom<&'a PasswordHash<'a>> for Params

Available on crate feature password-hash only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(hash: &'a PasswordHash<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&Params> for ParamsString

Available on crate feature password-hash only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(params: &Params) -> Result<ParamsString>

Performs the conversion.

impl<'a> TryFrom<Params> for ParamsString

Available on crate feature password-hash only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(params: Params) -> Result<ParamsString>

Performs the conversion.

impl TryFrom<ParamsBuilder> for Params

type Error = Error

The type returned in the event of a conversion error.

fn try_from(builder: ParamsBuilder) -> Result<Params>

Performs the conversion.

impl Eq for Params

impl StructuralEq for Params

impl StructuralPartialEq for Params

Auto Trait Implementations

impl RefUnwindSafe for Params

impl Send for Params

impl Sync for Params

impl Unpin for Params

impl UnwindSafe for Params

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.