Struct lib3h_sodium::SecureBuffer

pub struct SecureBuffer { /* fields omitted */ }

A secure buffer implementation of lib3h_crypto_api::Buffer making use of libsodium's implementation of mlock and mprotect.

Methods

impl SecureBuffer

pub fn new(size: usize) -> Self

Trait Implementations

impl Send for SecureBuffer

impl Drop for SecureBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for SecureBuffer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for SecureBuffer

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SecureBuffer

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Debug for SecureBuffer

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

Formats the value using the given formatter.

impl Buffer for SecureBuffer

fn box_clone(&self) -> Box<dyn Buffer>

Buffer is designed to be used as a trait-object Since we can't get a sized clone, provide clone in a Box.

fn as_buffer(&self) -> &dyn Buffer

helps work around some sizing issues with rust trait-objects

fn as_buffer_mut(&mut self) -> &mut dyn Buffer

helps work around some sizing issues with rust trait-objects

fn len(&self) -> usize

get the length of the buffer

fn is_empty(&self) -> bool

is this a zero-length buffer?

fn set_no_access(&self)

mark this buffer as no-access memory protection (note, this is a no-op for Vecs)

fn set_readable(&self)

mark this buffer as read-only memory protection (note, this is a no-op for Vecs)

fn set_writable(&self)

mark this buffer as read-write memory protection (note, this is a no-op for Vecs)

fn read_lock(&self) -> ReadLocker

return a locker object that marks this Buffer readable until the locker goes out of scope

fn write_lock(&mut self) -> WriteLocker

return a locker object that marks this Buffer writable until the locker goes out of scope

fn zero(&mut self)

fill the buffer with zeroes

fn write(&mut self, offset: usize, data: &[u8]) -> Result<(), CryptoError>

write data into this buffer at given offset this function will return CryptoError::WriteOverflow if data is too long