Struct Params

pub struct Params { /* private fields */ }

The Scrypt parameter values.

Implementations

impl Params

pub const RECOMMENDED_LOG_N: u8 = 17u8

Recommended log₂ of the Scrypt parameter N: CPU/memory cost.

pub const RECOMMENDED_R: u32 = 8u32

Recommended Scrypt parameter r: block size.

pub const RECOMMENDED_P: u32 = 1u32

Recommended Scrypt parameter p: parallelism.

pub const RECOMMENDED_LEN: usize = 32usize

Recommended Scrypt parameter Key length.

pub fn new(log_n: u8, r: u32, p: u32) -> Result<Params, InvalidParams>

Create a new instance of Params.

Arguments

• log_n - The log₂ of the Scrypt parameter N
• r - The Scrypt parameter r
• p - The Scrypt parameter p

Conditions

• log_n must be less than 64
• r must be greater than 0 and less than or equal to 4294967295
• p must be greater than 0 and less than 4294967295

pub fn new_with_output_len( log_n: u8, r: u32, p: u32, len: usize, ) -> Result<Params, InvalidParams>

Available on crate feature password-hash only.

Create a new instance of Params, overriding the output length.

Note that this length is only intended for use with the PasswordHasher API, and not with the low-level scrypt::scrypt API, which determines the output length using the size of the output slice.

The allowed values for len are between 10 bytes (80 bits) and 64 bytes inclusive. These lengths come from the PHC string format specification because they are intended for use with password hash strings.

pub const fn recommended() -> Params

Recommended values according to the OWASP cheat sheet

• log_n = 17 (n = 131072)
• r = 8
• p = 1

pub const fn log_n(&self) -> u8

log₂ of the Scrypt parameter N, the work factor.

Memory and CPU usage scale linearly with N. If you need N, use Params::n instead.

pub const fn n(&self) -> u64

N parameter: the work factor.

This method returns 2 to the power of Params::log_n. Memory and CPU usage scale linearly with N.

pub const fn r(&self) -> u32

r parameter: resource usage.

scrypt iterates 2*r times. Memory and CPU time scale linearly with this parameter.

pub const fn p(&self) -> u32

p parameter: parallelization.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Params

Returns the “default value” for a type.

impl PartialEq for Params

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

Available on crate feature simple only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Params> for ParamsString

Available on crate feature simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: Params) -> Result<ParamsString, Error>

Performs the conversion.

impl Copy for Params

impl StructuralPartialEq for Params