Struct argon2::Argon2

source · [−]

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

Expand description

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

source

impl<'key> Argon2<'key>

source

pub fn new(algorithm: Algorithm, version: Version, params: Params) -> Self

Create a new Argon2 context.

source

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

Create a new Argon2 context.

source

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

Available on crate feature alloc only.

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

source

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

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.

source

pub fn params(&self) -> &Params

Get default configured Params.

Trait Implementations

source

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

source

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

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

source

impl Default for Argon2<'_>

source

fn default() -> Self

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

source

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

source

fn from(params: &Params) -> Self

Converts to this type from the input type.

source

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

source

fn from(params: Params) -> Self

Converts to this type from the input type.

source

impl PasswordHasher for Argon2<'_>

Available on crate features alloc and password-hash only.

type Params = Params

Algorithm-specific parameters.

source

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

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

source

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

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

Auto Trait Implementations

impl<'key> RefUnwindSafe for Argon2<'key>

impl<'key> Send for Argon2<'key>

impl<'key> Sync for Argon2<'key>

impl<'key> Unpin for Argon2<'key>

impl<'key> UnwindSafe for Argon2<'key>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

source

impl<T> PasswordVerifier for T where
T: PasswordHasher,

source

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

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

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

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 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct argon2::Argon2

Implementations

impl<'key> Argon2<'key>

pub fn new(algorithm: Algorithm, version: Version, params: Params) -> Self

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

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

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

pub fn params(&self) -> &Params

Trait Implementations

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

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

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

impl Default for Argon2<'_>

fn default() -> Self

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

fn from(params: &Params) -> Self

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

fn from(params: Params) -> Self

impl PasswordHasher for Argon2<'_>

type Params = Params

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

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

Auto Trait Implementations

impl<'key> RefUnwindSafe for Argon2<'key>

impl<'key> Send for Argon2<'key>

impl<'key> Sync for Argon2<'key>

impl<'key> Unpin for Argon2<'key>

impl<'key> UnwindSafe for Argon2<'key>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> PasswordVerifier for T where T: PasswordHasher,

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

impl<T> Pointable for T

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

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> PasswordVerifier for T where
T: PasswordHasher,

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

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

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

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