Struct SafeSecretKey

pub struct SafeSecretKey { /* private fields */ }

Securely stores a secret key in memory that is zeroized on drop. Care is taken so that when this struct is constructed or moved that additional copies of the secret are not made in memory or disk. https://github.com/veorq/cryptocoding#clean-memory-of-secret-data

Unfortunately the SafeSecretKey is not magic, there are some things to be aware of when using it…

• The memory used when constructing the secret key must also be zeroized, but this is left as an exercise to the caller.
• If you mem::forget the SafeSecretKey or otherwise don’t drop it, the secret will not be zeroized.
• When the caller lends out a reference to the SecretKey (available for example via Deref) it is the responsibility of the caller to not Clone the SecretKey or otherwise make a copy of it’s memory

Methods from Deref<Target = SecretKey>

pub fn as_ptr(&self) -> *const u8

Converts the object to a raw pointer for FFI interfacing

pub fn len(&self) -> usize

Returns the length of the object as an array

pub fn is_empty(&self) -> bool

Returns whether the object as an array is empty

Trait Implementations

impl Debug for SafeSecretKey

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

Formats the value using the given formatter.

impl Deref for SafeSecretKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for SafeSecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> TryFrom<&'a SecretKey> for SafeSecretKey

type Error = ()

The type returned in the event of a conversion error.

fn try_from(secret: &'a SecretKey) -> Result<Self, ()>

Performs the conversion.