[][src]Struct orion::aead::SecretKey

pub struct SecretKey { /* fields omitted */ }

A type to represent a secret key.

As default it will randomly generate a SecretKey of 32 bytes.


An error will be returned if:

  • slice is empty.
  • length is 0.
  • length is not less than u32::max_value().


A panic will occur if:

  • Failure to generate random bytes securely.


  • 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 call unprotected_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 prefer SecretType == &[u8] over SecretType.unprotected_as_bytes() == &[u8]. Examples are shown below. The examples apply to any type that implements PartialEq<&'_ [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)?);


impl SecretKey[src]

#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."] pub fn from_slice(slice: &[u8]) -> Result<SecretKey, 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<SecretKey, UnknownCryptoError>[src]

Randomly generate using a CSPRNG. Not available in no_std context.

Trait Implementations

impl Debug for SecretKey[src]

impl Default for SecretKey[src]

fn default() -> SecretKey[src]

Randomly generate using a CSPRNG with recommended size. Not available in no_std context.

impl Drop for SecretKey[src]

impl Eq for SecretKey[src]

impl<'_> PartialEq<&'_ [u8]> for SecretKey[src]

impl PartialEq<SecretKey> for SecretKey[src]

Auto Trait Implementations

Blanket Implementations

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> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.