Struct orion::aead::SecretKey

#[must_use]
pub struct SecretKey { /* fields omitted */ }

A type to represent a secret key.

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

Note:

Due to the return type of the Default trait, the default() method cannot let the caller handle a failing CSPRNG. If the CSPRNG fails, that function panics. If handling a failing CSPRNG's error is needed, use instead generate().

Exceptions:

An exception will be thrown if:

• slice is empty.
• The OsRng fails to initialize or read from its source.
• length is 0.
• length is not less than u32::max_value().

Security:

• Avoid using unprotected_as_bytes() whenever possible, as it breaks all protections that the type implements.

Methods

impl SecretKey

#[must_use]

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

Make an object from a given byte slice.

#[must_use]

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 get_length(&self) -> usize

Return the length of the object.

#[must_use]

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

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

Trait Implementations

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

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 ==.

#[must_use]

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

This method tests for !=.

impl Default for SecretKey

#[must_use]

fn default() -> SecretKey

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

impl Debug for SecretKey

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

Formats the value using the given formatter.