Struct orion::hazardous::hash::blake2b::SecretKey

pub struct SecretKey { /* private fields */ }

A type to represent the SecretKey that BLAKE2b uses for keyed mode.

Note:

SecretKey pads the secret key for use with BLAKE2b, when initialized.

Exceptions:

An exception will be thrown if:

• slice is empty.
• slice is greater than 64 bytes.
• The OsRng fails to initialize or read from its source.

Security:

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

Implementations

impl SecretKey

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

Make an object from a given byte slice.

pub fn get_original_length(&self) -> usize

Get the original size of the key, before padding.

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

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

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.

Trait Implementations

impl Debug for SecretKey

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

Formats the value using the given formatter.

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

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.