Purpose: the goal for this project is to encrypt .env files for a given Rust application and store them in an encrypted state, then decrypt them at runtime using an OS-based environment variable and pass them to the application. This requires any potential/illicit attacker to breach the operating system's security and access its environment variables before any application-level environment variables can be compromised.
Now uses PQ (Post-Quantum) cryptographic algorithms 💅
Disclaimer: this project is stable and can be used in production environments, but SLA-based support won't be offered until we're at v1.0 and/or sponsored. 
- Install Rust 🌎
- Clone/fork the env_encryption_tool repo ⚡
- Set an OS-level environment variable named "DECRYPTION_KEY" ( 🌎 for Linux, 🌍 for Windows, 🌏 for MacOS) to your desired 32-byte/character value 🔒
- Run "cargo build --release" - this outputs a binary in the target/release folder ✨
- Run the binary in the same folder as your .env file - this outputs a env.enc file 🎊
- Integrate the included decrypt_config.rs file and its crates into your Rust project ⭐
- Copy the env.enc file to the same folder your Rust binary runs in and voila! You have encrypted environment variables provided to your application at runtime. 🎉
We welcome contributions from the community! A simple guide to get started:
- Fork the repository to your Github account (a.k.a create a branch).
- Clone your forked repo/branch to your favorite IDE (VS Code is our editor of choice) and make changes (or use the command-line: git checkout -b feature/your-feature).
- Thoroughly test and debug your changes, then commit and push them to your forked repo/branch.
- Open a pull request to have your changes reviewed and reintegrated into the main branch.
Contributors are strongly encouraged to read our CONTRIBUTING.md file before opening a pull request.
env_encryption_tool is licensed under the AGPL-3.0 license, making it free to use, modify, and distribute as long as the source code remains open-source. Using a modified version of this software without disclosing its source code is not in compliance with the AGPL-3.0 license.
Special thanks to contributors, open-source enthusiasts, and supporters of env_encryption_tool's vision.
Please read our Terms of Service before using our software. Violators of these Terms are not supported by the community or contributors.
Please also read our Privacy Policy to understand how we handle your personal information.
Have questions or suggestions? Reach out to us at dev@butlergroup.net. Thank you and happy coding! :)
