envcloak 0.2.2

Securely manage encrypted environment variables with ease.

🔒 EnvCloak

"Because Your Secrets Deserve Better Than Plaintext!"

Welcome to EnvCloak, the ultimate sidekick for developers, ops folks, and anyone who’s ever accidentally committed an API key to version control. (Yes, I know… it happens to the best of us. 😅) EnvCloak takes the stress out of managing environment variables by wrapping them in the cozy blanket of encryption, so you can focus on building awesome things—without the lingering fear of a security breach.

If you find EnvCloak useful, please ⭐ the repository. It helps others discover this project! - thank you!

🛠️ Installation

In order to install envcloak simply run:

pip install envcloak

or if you want dev tools too 😎:

pip install envcloak[dev]

👋 There are also self-contained binaries for Windows, Linux and MacOS, don't have to use python at all! 🥳

🚀 Example Workflow

ℹ️ More examples are present in examples section.

Generating key:

# With password and salt
envcloak generate-key-from-password --password "YourTopSecretPassword" \
--salt "e3a1c8b0d4f6e2c7a5b9d6f0cr2ad1a2" --output secretkey.key

# With password without salt (we will add random salt then)
envcloak generate-key-from-password --password "YourTopSecretPassword" --output secretkey.key

# From random password and salt
envcloak generate-key --output secretkey.key

What it does: generates your private key used to encrypt and decrypt files. Appends (or creates if needed) .gitignore as well as super-hero should! 🎉

⚠ If someone knows your password and salt (option 1) can recreate same key - keep those variables safe as key itself ⚠

Encrypting Variables:

envcloak encrypt --input .env --output .env.enc --key-file mykey.key

What it does: Encrypts your .env file with a specified key, outputting a sparkling .env.enc file.

Decrypting Variables:

envcloak decrypt --input .env.enc --output .env --key-file mykey.key

What it does: Decrypts the .env.enc file back to .env using the same key. Voilà!

or you may want to use it ...

🐍 In Your Python Code

from envcloak import load_encrypted_env

load_encrypted_env('.env.enc', key_file='mykey.key').to_os_env()
# Now os.environ contains the decrypted variables

What it does: Loads decrypted variables directly into os.environ. Secrets delivered, stress-free.

🛠️ Implementation Details

🔑 Encryption Algorithm

• Powered by AES-256-GCM for speed and security.
• Provides sha3 validation of files and content.

🗝️ Key Storage

• Local key files with strict permissions.
• Secure environment variables for CI/CD systems.

🗂️ File Handling

• Works with individual files.
• Works with directories using --directory instead of --input on encrypt and decrypt.

ℹ️ EnvCloak process files in batch one-by-one.

• Can recursively encrypt or decrypt directories.

🚦 Error Handling

• Clear, friendly error messages for any hiccups.
• Gracefully handles missing keys or corrupted files.

✅ Compatibility of pipelines and systems

• k8s / OKD / OCP deployments
• Jenkins pipelines
• Azure Pipelines
• Github Workflows
• Gitlab CI/CD Pipelines

🎉 Why EnvCloak?

Because you deserve peace of mind. EnvCloak wraps your environment variables in layers of encryption goodness, protecting them from prying eyes and accidental slips. Whether you’re a solo dev or part of a big team, this tool is here to make managing secrets simple, secure, and downright pleasant.

So go ahead—secure your .env like a boss. And remember, EnvCloak isn’t just a tool; it’s your secret-keeping partner in crime. (But the good kind of crime. 😎)

Comparison of EnvCloak with Alternatives

Tool	Strengths	Weaknesses
EnvCloak	Lightweight, Python-native, simple to integrate with CI/CD workflows.	Limited ecosystem compared to established tools.
Sops	Integrates with cloud providers, supports partial file encryption.	More complex to configure for beginners.
BlackBox	Simple file-based encryption for Git repos.	Limited to GPG, lacks flexibility.
Vault	Robust, enterprise-grade with dynamic secrets.	High complexity, overkill for small projects.
Confidant	AWS IAM integration, designed for secure CI/CD workflows.	Requires AWS, limited to its ecosystem.
Doppler	Centralized secret management with CI/CD integration.	Paid plans for advanced features, cloud-reliant.

Key Differentiator for EnvCloak: Focused specifically on Python developers and lightweight CI/CD needs, making it ideal for small to medium projects.

🌟 Hall of Fame

A huge thanks to all our amazing contributors! 🎉

🔗 Get Started Today!

Don’t let your API keys end up in the wrong hands (or on Twitter). Grab EnvCloak now and start encrypting like a pro.

Happy env Cloaking! 🕵️‍♂️