Struct orion::aead::SecretKey

pub struct SecretKey { /* private fields */ }

Available on crate feature safe_api only.

A type to represent a secret key.

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

Errors:

An error will be returned if:

• slice is empty.
• length is 0.
• length is not less than isize::MAX.

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 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_ne!(password, &[0; 32][..]);

// Secure, constant-time comparison with another Password
assert_ne!(password, Password::generate(32)?);

Implementations

impl SecretKey

pub fn from_slice(slice: &[u8]) -> Result<SecretKey, UnknownCryptoError>

Construct from a given byte slice.

pub fn unprotected_as_bytes(&self) -> &[u8]

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

Return the length of the object.

pub fn is_empty(&self) -> bool

Return true if this object does not hold any data, false otherwise.

NOTE: This method should always return false, since there shouldn’t be a way to create an empty instance of this object.

pub fn generate(length: usize) -> Result<SecretKey, UnknownCryptoError>

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

Trait Implementations

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Default for SecretKey

fn default() -> SecretKey

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

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<&[u8]> for SecretKey

fn eq(&self, other: &&[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<SecretKey> for SecretKey

fn eq(&self, other: &SecretKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SecretKey