Struct bonsaidb::local::argon2::Argon2

pub struct Argon2<'key> { /* private fields */ }

Argon2 context.

This is the primary type of this crate’s API, and contains the following:

• Argon2 Algorithm variant to be used
• Argon2 Version to be used
• Default set of Params to be used
• (Optional) Secret key a.k.a. “pepper” to be used

Implementations

impl<'key> Argon2<'key>

pub fn new(algorithm: Algorithm, version: Version, params: Params) -> Argon2<'key>

Create a new Argon2 context.

pub fn new_with_secret(
    secret: &'key [u8],
    algorithm: Algorithm,
    version: Version,
    params: Params
) -> Result<Argon2<'key>, Error>

Create a new Argon2 context.

pub fn hash_password_into(
    &self,
    pwd: &[u8],
    salt: &[u8],
    out: &mut [u8]
) -> Result<(), Error>

Hash a password and associated parameters into the provided output buffer.

pub fn hash_password_into_with_memory(
    &self,
    pwd: &[u8],
    salt: &[u8],
    out: &mut [u8],
    memory_blocks: impl AsMut<[Block]>
) -> Result<(), Error>

Hash a password and associated parameters into the provided output buffer.

This method takes an explicit memory_blocks parameter which allows the caller to provide the backing storage for the algorithm’s state:

• Users with the alloc feature enabled can use Argon2::hash_password_into to have it allocated for them.
• no_std users on “heapless” targets can use an array of the Block type to stack allocate this buffer.

pub fn params(&self) -> &Params

Get default configured Params.

Trait Implementations

impl<'key> Clone for Argon2<'key>

fn clone(&self) -> Argon2<'key>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Argon2<'_>

fn default() -> Argon2<'_>

Returns the “default value” for a type.

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

fn from(params: &Params) -> Argon2<'key>

Converts to this type from the input type.

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

fn from(params: Params) -> Argon2<'key>

Converts to this type from the input type.

impl PasswordHasher for Argon2<'_>

type Params = Params

Algorithm-specific parameters.

fn hash_password<S, 'a>(
    &self,
    password: &[u8],
    salt: &'a S
) -> Result<PasswordHash<'a>, Error>where
    S: AsRef<str> + ?Sized,

Simple API for computing a PasswordHash from a password and salt value.

fn hash_password_customized<'a>(
    &self,
    password: &[u8],
    alg_id: Option<Ident<'a>>,
    version: Option<u32>,
    params: Params,
    salt: impl Into<Salt<'a>>
) -> Result<PasswordHash<'a>, Error>

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