Struct secstr::SecStr

pub struct SecStr { /* 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
  

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 SecStr

fn new(cont: Vec<u8>) -> SecStr

fn unsecure(&self) -> &[u8]

Borrow the contents of the string.

fn unsecure_mut(&mut self) -> &mut [u8]

Mutably borrow the contents of the string.

fn zero_out(&mut self)

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

Trait Implementations

impl Clone for SecStr

fn clone(&self) -> SecStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> From<T> for SecStr where T: Into<Vec<u8>>

fn from(s: T) -> SecStr

Performs the conversion.

impl Borrow<[u8]> for SecStr

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

Immutably borrows from an owned value.

impl BorrowMut<[u8]> for SecStr

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

Mutably borrows from an owned value.

impl Drop for SecStr

fn drop(&mut self)

A method called when the value goes out of scope.

impl PartialEq for SecStr

fn eq(&self, other: &SecStr) -> 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 !=.

impl Debug for SecStr

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

Formats the value using the given formatter.

impl Display for SecStr

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

Formats the value using the given formatter.