Struct Scrypt 

pub struct Scrypt { /* private fields */ }

Available on crate features kdf or mcf or phc only.

scrypt password hashing type which can produce and verify strings in either the Password Hashing Competition (PHC) string format which begin with $scrypt$, or in Modular Crypt Format (MCF) which begin with $7$.

This type holds the default parameters to use when computing password hashes.

See the toplevel documentation for a code example.

Implementations

impl Scrypt

pub const fn new() -> Self

Initialize Scrypt with default parameters.

pub const fn new_with_params(params: Params) -> Self

Initialize Scrypt with the provided parameters.

Trait Implementations

impl Clone for Scrypt

fn clone(&self) -> Scrypt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomizedPasswordHasher<PasswordHash> for Scrypt

Available on crate feature mcf only.

type Params = Params

Algorithm-specific parameters.

fn hash_password_customized( &self, password: &[u8], salt: &[u8], alg_id: Option<&str>, version: Option<Version>, params: Params, ) -> Result<PasswordHash>

Compute a PasswordHash from the provided password using an explicit set of customized algorithm parameters as opposed to the defaults.

fn hash_password_with_params( &self, password: &[u8], salt: &[u8], params: Self::Params, ) -> Result<H, Error>

Compute a PasswordHash using customized parameters only, using the default algorithm and version.

impl CustomizedPasswordHasher<PasswordHash> for Scrypt

Available on crate feature phc only.

type Params = Params

Algorithm-specific parameters.

fn hash_password_customized( &self, password: &[u8], salt: &[u8], alg_id: Option<&str>, version: Option<Version>, params: Params, ) -> Result<PasswordHash>

Compute a PasswordHash from the provided password using an explicit set of customized algorithm parameters as opposed to the defaults.

fn hash_password_with_params( &self, password: &[u8], salt: &[u8], params: Self::Params, ) -> Result<H, Error>

Compute a PasswordHash using customized parameters only, using the default algorithm and version.

impl Debug for Scrypt

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

Formats the value using the given formatter.

impl Default for Scrypt

fn default() -> Scrypt

Returns the “default value” for a type.

impl From<Params> for Scrypt

fn from(params: Params) -> Self

Converts to this type from the input type.

impl Kdf for Scrypt

Available on crate feature kdf only.

fn derive_key(&self, password: &[u8], salt: &[u8], out: &mut [u8]) -> Result<()>

Writes uniformly random data suitable as key material into the entire length of out, derived from the following inputs:

impl PartialEq for Scrypt

fn eq(&self, other: &Scrypt) -> 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 PasswordHasher<PasswordHash> for Scrypt

Available on crate feature mcf only.

fn hash_password_with_salt( &self, password: &[u8], salt: &[u8], ) -> Result<PasswordHash>

Compute the hash H from the given password and salt, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password(&self, password: &[u8]) -> Result<H, Error>

Available on crate feature getrandom only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password_with_rng<R>( &self, rng: &mut R, password: &[u8], ) -> Result<H, Error>

where R: TryCryptoRng + ?Sized,

Available on crate feature rand_core only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

impl PasswordHasher<PasswordHash> for Scrypt

Available on crate feature phc only.

fn hash_password_with_salt( &self, password: &[u8], salt: &[u8], ) -> Result<PasswordHash>

Compute the hash H from the given password and salt, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password(&self, password: &[u8]) -> Result<H, Error>

Available on crate feature getrandom only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password_with_rng<R>( &self, rng: &mut R, password: &[u8], ) -> Result<H, Error>

where R: TryCryptoRng + ?Sized,

Available on crate feature rand_core only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

impl PasswordVerifier<PasswordHash> for Scrypt

Available on crate feature mcf only.

fn verify_password(&self, password: &[u8], hash: &PasswordHash) -> Result<()>

Compute this password hashing function against the provided password using the parameters from the provided password hash and see if the computed output matches.

impl PasswordVerifier<PasswordHashRef> for Scrypt

Available on crate feature mcf only.

fn verify_password(&self, password: &[u8], hash: &PasswordHashRef) -> Result<()>

Compute this password hashing function against the provided password using the parameters from the provided password hash and see if the computed output matches.

impl Copy for Scrypt

impl Pbkdf for Scrypt

Available on crate feature kdf only.

impl StructuralPartialEq for Scrypt