ma_proper 0.1.1

This crate provides the cleaning memory allocator `MAProper`
docs.rs failed to build ma_proper-0.1.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: ma_proper-1.0.0

BSD-2-Clause License MIT License Travis CI Appveyor CI

MAProper

This crate provides the cleaning memory allocator MAProper 🧹

What is MAProper

MAProper is an extension around std::alloc::System which ensures that the allocated memory is always erased before it is deallocated by using one of memset_s/SecureZeroMemory/explicit_bzero/explicit_memset.

Whats the purpose of MAProper

MAProper becomes handy if you're dealing with a lot of sensitive data: because the memory management of dynamically allocating types like Vec or String is opaque, you basically have no real chance to reliably erase their sensitive contents.

However they all use the global allocator – so all ways lead to Rome (or in this case to the global allocator's alloc and dealloc functions) – which is where MAProper is sitting and waiting to take care of the discarded memory.

Using MAProper as global allocator (example)

#[global_allocator]
static MA_PROPER: MAProper = MAProper;

fn main() {
	// This `Vec` will allocate memory through `MA_PROPER` above
	let mut v = Vec::new();
	v.push(1);
}

Important

Please note that MAProper only erases memory that is deallocated properly. This especially means that:

  • stack items are not overwritten by this allocator (therefore we expose MAProper::erase or MAProper::erase_ptr<T> so that you can erase them manually if necessary)
  • depending on your panic-policy and your Rc/Arc use (retain-cycles), the destructor (and thus the deallocator) may never be called

⚠️ Alpha-Warning ⚠️

This crate is in an early alpha state; so be careful and don't rely on it if you haven't checked it by yourself!