Struct secstr::SecVec

pub struct SecVec<T> where
    T: Sized + Copy,  { /* fields omitted */ }

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)

Be careful with SecStr::from: if you have a borrowed string, it will be copied. Use SecStr::new if you have a Vec<u8>.

Methods

impl<T> SecVec<T> where
    T: Sized + Copy, 

pub fn new(cont: Vec<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.

pub fn zero_out(&mut self)

Overwrite the string with zeros. This is automatically called in the destructor.

Trait Implementations

impl<T> Borrow<[T]> for SecVec<T> where
    T: Sized + Copy, 

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T> BorrowMut<[T]> for SecVec<T> where
    T: Sized + Copy, 

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

Mutably borrows from an owned value.

impl<T: Clone> Clone for SecVec<T> where
    T: Sized + Copy, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SecVec<T> where
    T: Sized + Copy, 

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

impl<T, U> From<U> for SecVec<T> where
    U: Into<Vec<T>>,
    T: Sized + Copy, 

fn from(s: U) -> SecVec<T>

Performs the conversion.

impl<T, U> Index<U> for SecVec<T> where
    T: Sized + Copy,
    Vec<T>: Index<U>, 

type Output = <Vec<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<SecVec<T>> for SecVec<T> where
    T: Sized + Copy, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> StructuralEq for SecVec<T> where
    T: Sized + Copy,