3 releases
0.0.3 | Jun 27, 2024 |
---|---|
0.0.2 | Jun 25, 2024 |
0.0.1 | Jun 25, 2024 |
#1777 in Cryptography
Used in 2 crates
73KB
1K
SLoC
What is it?
volaris-crypto is a library used for managing cryptographic functions and headers that adhere to the volaris format.
Security
volaris-crypto uses modern, secure and audited1 AEADs for encryption and decryption.
You may find the audits for both AES-256-GCM and XChaCha20-Poly1305 on the NCC Group's website.
Who uses volaris-crypto?
This library is implemented by volaris, a secure multi-interface file encryption utility.
volaris-crypto makes it easy to integrate the volaris format into your own projects (and if there's a feature that you'd like to see, please don't hesitate to open a Github issue).
Features
- Convenience functions for encrypting/decrypting
- 2 AEADs (XChaCha20-Poly1305, AES-256-GCM) 1 Deoxys-II-256 was a former AEAD, though this is now disabled.
- Easy management of encrypted headers (no more worrying about where to store a nonce!)
- Easy
argon2id
hashing with secure parameters - Easy
balloon
hashing with secure parameters and BLAKE3 - Frequent updates and feature additions!
Examples
Deserializing a header:
let header_bytes: [u8; 64] = [
222, 2, 14, 1, 12, 1, 142, 88, 243, 144, 119, 187, 189, 190, 121, 90, 211, 56, 185, 14, 76,
45, 16, 5, 237, 72, 7, 203, 13, 145, 13, 155, 210, 29, 128, 142, 241, 233, 42, 168, 243,
129, 0, 0, 0, 0, 0, 0, 214, 45, 3, 4, 11, 212, 129, 123, 192, 157, 185, 109, 151, 225, 233,
161,
];
let mut cursor = Cursor::new(header_bytes);
// the cursor may be a file, this is just an example
let (header, aad) = Header::deserialize(&mut cursor).unwrap();
Writing a header to a file:
let mut output_file = File::create("test").unwrap();
header.write(&mut output_file).unwrap();
Encrypting and decrypting in-memory:
// obviously the key should contain data, not be an empty vec
let raw_key = Protected::new(vec![0u8; 128]);
let salt = gen_salt();
let key = balloon_hash(raw_key, &salt, &HeaderVersion::V4).unwrap();
let cipher = Ciphers::initialize(key, &Algorithm::XChaCha20Poly1305).unwrap();
let secret = "super secret information";
let nonce = gen_nonce(&Algorithm::XChaCha20Poly1305, &Mode::MemoryMode);
let encrypted_data = cipher.encrypt(&nonce, secret.as_bytes()).unwrap();
let decrypted_data = cipher.decrypt(&nonce, encrypted_data.as_slice()).unwrap();
assert_eq!(secret, decrypted_data);
You can read more about volaris, volaris-crypto and the technical details in the project's main documentation!
Thank you!
volaris-crypto exclusively uses AEADs provided by the RustCrypto Team, so I'd like to give them a huge thank you for their hard work (this wouldn't have been possible without them!)
Dependencies
~4–13MB
~139K SLoC