A [Rust] library that implements a data type (wrapper around Vec<u8>) suitable for storing sensitive information such as passwords and private keys in memory.
Inspired by Haskell [securemem] and .NET [SecureString].
Featuring:
mlock protection if possible***SECRET*** to prevent leaking into logs```rust extern crate secstr; use secstr::*;
let pw = SecStr::from("correct horse battery staple");
// Compared in constant time: // (Obviously, you should store hashes in real apps, not plaintext passwords) let arepwsequal = pw == SecStr::from("correct horse battery staple".to_string()); // true
// Formatting, printing without leaking secrets into logs let texttoprint = format!("{}", SecStr::from("hello")); // "SECRET"
// Clearing memory // THIS IS DONE AUTOMATICALLY IN THE DESTRUCTOR // (but you can force it) let mut mysec = SecStr::from("hello"); mysec.zeroout(); asserteq!(my_sec.unsecure(), b"\x00\x00\x00\x00\x00"); ```
Be careful with SecStr::from: if you have a borrowed string, it will be copied.
Use SecStr::new if you have a Vec<u8>.
Please feel free to submit pull requests! Bugfixes and simple non-breaking improvements will be accepted without any questions :-)
By participating in this project you agree to follow the Contributor Code of Conduct.
The list of contributors is available on GitHub.
This is free and unencumbered software released into the public domain.
For more information, please refer to the UNLICENSE file or unlicense.org.