[−][src]Struct orion::pwhash::Password
A type to represent the Password
that Argon2i hashes and uses for key derivation.
As default it will randomly generate a Password
of 32 bytes.
Errors:
An error will be returned if:
slice
is empty.length
is 0.length
is not less thanu32::max_value()
.
Panics:
A panic will occur if:
- Failure to generate random bytes securely.
Security:
-
Avoid using
unprotected_as_bytes()
whenever possible, as it breaks all protections that the type implements. -
The trait
PartialEq<&'_ [u8]>
is implemented for this type so that users are not tempted to callunprotected_as_bytes
to compare this sensitive value to a byte slice. The trait is implemented in such a way that the comparison happens in constant time. Thus, users should preferSecretType == &[u8]
overSecretType.unprotected_as_bytes() == &[u8]
. Examples are shown below. The examples apply to any type that implementsPartialEq<&'_ [u8]>
.
use orion::pwhash::Password; // Initialize a password with 32 random bytes. let password = Password::generate(32)?; // Secure, constant-time comparison with a byte slice assert!(password != &[0; 32][..]); // Secure, constant-time comparison with another Password assert!(password != Password::generate(32)?);
Methods
impl Password
[src]
#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."]
pub fn from_slice(slice: &[u8]) -> Result<Password, UnknownCryptoError>
[src]
Construct from a given byte slice.
pub fn unprotected_as_bytes(&self) -> &[u8]
[src]
Return the object as byte slice. Warning: Should not be used unless strictly needed. This breaks protections that the type implements.
pub fn len(&self) -> usize
[src]
Return the length of the object.
#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."]
pub fn generate(length: usize) -> Result<Password, UnknownCryptoError>
[src]
Randomly generate using a CSPRNG. Not available in no_std
context.
Trait Implementations
impl Debug for Password
[src]
impl Default for Password
[src]
fn default() -> Password
[src]
Randomly generate using a CSPRNG with recommended size. Not available in no_std
context.
impl Drop for Password
[src]
impl Eq for Password
[src]
impl<'_> PartialEq<&'_ [u8]> for Password
[src]
impl PartialEq<Password> for Password
[src]
Auto Trait Implementations
impl RefUnwindSafe for Password
impl Send for Password
impl Sync for Password
impl Unpin for Password
impl UnwindSafe for Password
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,