include-crypt-bytes 0.1.3

Rust macro to embed encrypted files in compiled binary
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Procedural macro to embed encrypted binary data in compiled binaries.
//!
//! The macro works similarly to [`std::include_str`], but instead of embedding the UTF-8
//! string, it embeds encrypted `[u8]` array. Encryption uses the [chacha20poly1305][1] crate.
//!
//! # Examples
//!
//! ```rust
//! # use include_crypt_bytes::include_bytes_crypt;
//! # let password = "The password to use at runtime to decrypt";
//! // CONFIG_PASSWORD is the environment variable set to the
//! // string used to encrypt the contents of the file config.toml
//! // at compile time
//! //
//! // `password` is the variable used to decrypt the embedded data
//! // at runtime.
//! let file_bytes = include_bytes_crypt!(
//!                     "config.toml",
//!                     password.as_bytes(),
//!                     "CONFIG_PASSWORD");
//! ```
//!
//! Sometimes, its useful just to obfuscate the embedded data. In that case just the file name is required
//!
//! ```rust
//! # use include_crypt_bytes::include_bytes_obfuscate;
//! // A random password is generated at compiled time
//! let file_bytes = include_bytes_obfuscate!("config.toml");
//! ```
//!
//! [1]: https://docs.rs/chacha20poly1305
pub use include_crypt_bytes_cipher::{decrypt_bytes, encrypt_bytes, CryptError};
pub use include_crypt_bytes_macro::{include_bytes_crypt, include_bytes_obfuscate};