Struct SecureBox

pub struct SecureBox<T>
where
    T: Copy,
{ /* private fields */ }

A data type suitable for storing sensitive information such as passwords and private keys in memory, that implements:

• Automatic zeroing in Drop
• Constant time comparison in PartialEq (does not short circuit on the first different character; but terminates instantly if strings have different length)
• Outputting ***SECRET*** to prevent leaking secrets into logs in fmt::Debug and fmt::Display
• Automatic mlock to protect against leaking into swap (any unix)
• Automatic madvise(MADV_NOCORE/MADV_DONTDUMP) to protect against leaking into core dumps (FreeBSD, DragonflyBSD, Linux)

Comparisons using the PartialEq implementation are undefined behavior (and most likely wrong) if T has any padding bytes.

Implementations

impl<T> SecureBox<T>

where T: Copy,

pub fn new(cont: Box<T>) -> Self

pub fn unsecure(&self) -> &T

Borrow the contents of the string.

pub fn unsecure_mut(&mut self) -> &mut T

Mutably borrow the contents of the string.

Trait Implementations

impl<T> Borrow<T> for SecureBox<T>

where T: Copy,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for SecureBox<T>

where T: Copy,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: Copy> Clone for SecureBox<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SecureBox<T>

where T: Copy,

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

Formats the value using the given formatter.

impl<T> Display for SecureBox<T>

where T: Copy,

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

Formats the value using the given formatter.

impl<T> Drop for SecureBox<T>

where T: Copy,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Hash for SecureBox<T>

where T: Copy + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U> Index<U> for SecureBox<T>

where T: Index<U> + Copy,

type Output = <T as Index<U>>::Output

The returned type after indexing.

fn index(&self, index: U) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Ord for SecureBox<T>

where T: Copy + Ord,

fn cmp(&self, other: &SecureBox<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for SecureBox<T>

where T: Copy + PartialEq,

fn eq(&self, other: &SecureBox<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for SecureBox<T>

where T: Copy + PartialOrd,

fn partial_cmp(&self, other: &SecureBox<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Eq for SecureBox<T>

where T: Copy + Eq,

impl<T> StructuralPartialEq for SecureBox<T>

where T: Copy,