Struct SecretWords

pub struct SecretWords { /* private fields */ }

Strictly memory protected bytes contain sensitive data.

This implementation borrows a lot of code and ideas from:

• https://crates.io/crates/memsec
• https://crates.io/crates/secrets
• https://download.libsodium.org/doc/memory_management

secrets is not good enough because it relies on libsodium which breaks the desired portability of this library (at least at the time of this writing).

memsec is not good enough because it focuses on protecting a generic type T which size is known at compile-time. In this library we are dealing with dynamic amounts of sensitive data and there is no point in securing a Vec<u8> via memsec … all we would achieve is protecting the pointer to sensitive data in unsecured space.

Implementations

impl SecretWords

pub fn from_secured(bytes: &[u8]) -> Self

Copy from slice of bytes.

This is not a regular From implementation because the caller has to ensure that the original bytes are zeroed out (or are already in some secured memspace. This different signature should be a reminder of that.

pub fn with_capacity(capacity: usize) -> SecretWords

pub fn zeroed(size: usize) -> SecretWords

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn capacity(&self) -> usize

pub fn borrow(&self) -> Ref<'_>

pub fn borrow_mut(&mut self) -> RefMut<'_>

pub fn locks(&self) -> isize

Trait Implementations

impl Clone for SecretWords

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for SecretWords

fn drop(&mut self)

Executes the destructor for this type.

impl From<&mut [Word]> for SecretWords

fn from(words: &mut [Word]) -> Self

Converts to this type from the input type.

impl From<&mut [u8]> for SecretWords

fn from(bytes: &mut [u8]) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for SecretWords

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl Send for SecretWords

impl Sync for SecretWords