Struct SecureArray

pub struct SecureArray<T, const LENGTH: usize>
where
    T: Copy + Zeroize,
{ /* 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, const LENGTH: usize> SecureArray<T, LENGTH>

where T: Copy + Zeroize,

pub fn new(content: [T; LENGTH]) -> 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, const LENGTH: usize> Borrow<[T]> for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

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

Immutably borrows from an owned value.

impl<T, const LENGTH: usize> BorrowMut<[T]> for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

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

Mutably borrows from an owned value.

impl<T: Copy + Zeroize, const LENGTH: usize> Clone for SecureArray<T, LENGTH>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, const LENGTH: usize> Debug for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

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

Formats the value using the given formatter.

impl<T, const LENGTH: usize> Display for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

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

Formats the value using the given formatter.

impl<T, const LENGTH: usize> Drop for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, const LENGTH: usize> From<[T; LENGTH]> for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

fn from(s: [T; LENGTH]) -> Self

Converts to this type from the input type.

impl<const LENGTH: usize> FromStr for SecureArray<u8, LENGTH>

type Err = TryFromSliceError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T, const LENGTH: usize> Hash for SecureArray<T, LENGTH>

where T: Copy + Zeroize + 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, const LENGTH: usize> Index<U> for SecureArray<T, LENGTH>

where T: Copy + Zeroize, [T; LENGTH]: Index<U>,

type Output = <[T; LENGTH] as Index<U>>::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LENGTH: usize> Ord for SecureArray<T, LENGTH>

where T: Copy + Zeroize + Ord,

fn cmp(&self, other: &SecureArray<T, LENGTH>) -> 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, const LENGTH: usize> PartialEq for SecureArray<T, LENGTH>

where T: Copy + Zeroize + PartialEq,

fn eq(&self, other: &SecureArray<T, LENGTH>) -> 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, const LENGTH: usize> PartialOrd for SecureArray<T, LENGTH>

where T: Copy + Zeroize + PartialOrd,

fn partial_cmp(&self, other: &SecureArray<T, LENGTH>) -> 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, const LENGTH: usize> TryFrom<Vec<T>> for SecureArray<T, LENGTH>

where T: Copy + Zeroize,

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, const LENGTH: usize> Eq for SecureArray<T, LENGTH>

where T: Copy + Zeroize + Eq,

impl<T, const LENGTH: usize> StructuralPartialEq for SecureArray<T, LENGTH>

where T: Copy + Zeroize,