Struct secstr::SecBox

pub struct SecBox<T>where
    T: Sized + 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> SecBox<T>where
    T: Sized + 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 SecBox<T>where
    T: Sized + Copy,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for SecBox<T>where
    T: Sized + Copy,

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

Mutably borrows from an owned value.

impl<T: Copy> Clone for SecBox<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 SecBox<T>where
    T: Sized + Copy,

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

Formats the value using the given formatter.

impl<T> Display for SecBox<T>where
    T: Sized + Copy,

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

Formats the value using the given formatter.

impl<T> Drop for SecBox<T>where
    T: Sized + Copy,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, U> Index<U> for SecBox<T>where
    T: Index<U> + Sized + 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> PartialEq<SecBox<T>> for SecBox<T>where
    T: Sized + Copy + NoPaddingBytes,

fn eq(&self, other: &SecBox<T>) -> 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.

impl<T> Eq for SecBox<T>where
    T: Sized + Copy + NoPaddingBytes,