update README

transfer
Avril 4 years ago
parent 9d9d878c2d
commit 901be81048
Signed by: flanchan
GPG Key ID: 284488987C31F630

@ -16,7 +16,7 @@ The `explicit_clear` feature forces any temporary work buffers to be zeroed out
It requires the nonstandard glibc extension `explicit_bzero(void*, size_t)` to build. It requires the nonstandard glibc extension `explicit_bzero(void*, size_t)` to build.
On x86 targets with the Rust nightly toolchain installed, this will also force a cache flush of the corresponding memory address. On x86 targets with the Rust nightly toolchain installed, this will also force a cache flush of the corresponding memory address.
This is *usually not needed*, and can cause a slowdown; but it prevents any lingering data being left in the buffer. This is *usually not needed*, and can cause a slowdown; but it prevents any lingering data being left in the buffer.
The unit test `remainder()` checks the process' memory map for leftover data in the working buffer when testing with this feature enabled. The unit test `remainder()` checks the process' memory map for leftover data in the working buffer when testing with this feature enabled. It is still unlikely data will remain even without this feature, depending on your system; you should only use it if you are very paranoid.
# Usage # Usage
Copies stdin to stdout while encrypting or decrypting with the stream cipher `chacha20_poly1305`. Copies stdin to stdout while encrypting or decrypting with the stream cipher `chacha20_poly1305`.

Loading…
Cancel
Save