Struct runtime::Guarded

pub struct Guarded<T: Bytes> { /* fields omitted */ }

A guarded type for protecting fixed-length secrets allocated on the heap.

Provides the following features and guarantees:

• Causes segfault upon access without using a borrow.
• Protected using mprotect:
  • Prot::NoAccess - when the box has no current borrows.
  • Prot::ReadOnly - when the box has at least one current immutable borrow.
  • Prot::ReadWrite - when the box has a current mutable borrow (can only have one at a time).
• The allocated memory uses guard pages both proceeding and following the memory. Overflows and large underflows cause immediate termination of the program.
• A canary proceeds the memory location to detect smaller underflows. The program will drop the underlying memory and terminate if detected.
• The Memory is locked with mlock.
• When the memory is freed, munlock is called.
• The memory is zeroed when no longer in use via sodium_free.
• Guarded types can be compared in constant time.
• Guarded types can not be printed using Debug.
• The interior data of a Guarded type may not be Clone.

Implementations

impl<T: Bytes> Guarded<T>

pub fn new<F>(f: F) -> Self where
    F: FnOnce(&mut T), 

pub fn try_new<R, E, F>(f: F) -> Result<Self, E> where
    F: FnOnce(&mut T) -> Result<R, E>, 

pub fn size(&self) -> usize

pub fn borrow(&self) -> Ref<'_, T>

pub fn borrow_mut(&mut self) -> RefMut<'_, T>

impl<T: Bytes + Randomized> Guarded<T>

pub fn random() -> Self

impl<T: Bytes + Zeroed> Guarded<T>

pub fn zero() -> Self

Trait Implementations

impl<T: Clone + Bytes> Clone for Guarded<T>

fn clone(&self) -> Guarded<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Bytes> Debug for Guarded<T>

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

Formats the value using the given formatter.

impl<T: Eq + Bytes> Eq for Guarded<T>

impl<T: Bytes + Zeroed> From<&'_ mut T> for Guarded<T>

fn from(data: &mut T) -> Self

Performs the conversion.

impl<T: Bytes + ConstEq> PartialEq<Guarded<T>> for Guarded<T>

fn eq(&self, rhs: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T: Bytes + Send> Send for Guarded<T>

impl<T: Bytes> StructuralEq for Guarded<T>

impl<T: Bytes + Sync> Sync for Guarded<T>