Add a comment

bitwarden · May 16, 2024 · 241698a · 241698a
1 parent 6fcd32e
commit 241698a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/bitwarden-crypto/src/allocator.rs b/crates/bitwarden-crypto/src/allocator.rs
@@ -4,6 +4,10 @@ use std::{
     sync::atomic,
 };
 
+/// Custom allocator that zeroizes memory before deallocating it
+///
+/// This is highly recommended to be enabled when using the Bitwarden crates to avoid sensitive data
+/// persisting in memory after it has been deallocated.
 pub struct ZeroizingAllocator<Alloc: GlobalAlloc>(pub Alloc);
 
 unsafe impl<T: GlobalAlloc> GlobalAlloc for ZeroizingAllocator<T> {