From c28bd6e547570a404a4b14426d2e47e6057452ff Mon Sep 17 00:00:00 2001 From: Radu Marias Date: Sun, 9 Jun 2024 23:28:33 +0300 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 822e59b..084d5e3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Securely clear secrets from memory. Built on stable Rust primitives which guaran It uses [zeroize](https://crates.io/crates/zeroize) crate under the hood to zeroize and [libsodium-sys](https://crates.io/crates/libsodium-sys) for `mlock()` and `munlock()`. **Maximum you can mlock is 4MB**. It can work with `bytearray` and `numpy array`. -> [!WARNING] +> [!WARNING] > **In the case of [Copy-on-write fork](https://en.wikipedia.org/wiki/Copy-on-write) you need to zeroize the memory before forking the child process, see example below. > Also by itself it doesn't work if memory is moved or moved to swap. You can use `zeroize.mlock()` to lock the memory, see example below.**