A lightweight, open-source tool for Python code obfuscation. CodeEnigma helps protect your logic from reverse engineering and unauthorized access, making it a practical alternative to PyArmor for securely distributing your Python applications
Project description
A lightweight, open-source tool for Python code obfuscation. CodeEnigma helps protect your logic from reverse engineering and unauthorized access, making it secure to distribute your Python applications.
🔒 Why CodeEnigma?
After searching extensively for a free and open-source Python obfuscation tool, I realized that most available options were either paid, closed-source, or opaque in how they worked. I wasn't comfortable letting a black-box tool obfuscate my production code without knowing exactly what it was doing — especially when it had access to sensitive logic.
So I built CodeEnigma — a transparent, self-contained solution that gives you full control over the obfuscation process, with no hidden logic and no external servers involved.
This project is inspired by PyArmor but with a different approach.
High Level Architecture
The working principle of CodeEnigma is simple:
- The user provides the path to the Python module to obfuscate.
- CodeEnigma reads the module's source code.
- An AES-256 key is generated using a secure random number generator and set in
private.py - Obfuscation runs file by file running the following steps:
- 4.1. Compile using
compile(code, str(file_path), "exec") - 4.2. Compress the byte code using
zlib.compress(compiled_code) - 4.3. Encode the compressed byte code using
base64.b64encode(compressed_code) - 4.4. Encrypt the encoded byte code using
AESGCM(SECRET_KEY).encrypt(NONCE, obfuscated, associated_data=None)refer for more details:
- 4.1. Compile using
- CodeEnigma creates a new module with the obfuscated code.
- A codeenigma_runtime.pyx file is created with the deobfuscation logic to decrypt and execute the obfuscated code.
- The runtime is compiled to a Python extension module using Cython. Also generates a codeenigma_runtime.whl file for distribution.
- End of process, the obfuscated module is ready to be distributed as wheel files.
Features
- 🔒 Strong encryption using AES-256
- 🔄 Simple API for obfuscating any python module
- 🔑 Secure and dynamic key generation
- 🛠️ Command-line interface for easy integration into build processes
- 📦 Lightweight and dependency-minimal
Installation
Using Poetry:
poetry add codeenigma
Using pip:
pip install codeenigma
Usage
CodeEnigma comes with a user-friendly command-line interface powered by Typer. The CLI provides helpful prompts and rich output.
Basic Usage
To obfuscate a Python module:
codeenigma obfuscate /path/to/your/module
Command Line Options
--expiration,-e: Set an expiration date for the obfuscated code (YYYY-MM-DD)--output,-o,--dist: Specify output directory (default: 'dist')--verbose,-v: Show detailed output
Examples
Obfuscate with an expiration date:
The following example will obfuscate the module and set the expiration date to December 31, 2025, at 23:59:59+0530 (IST).
codeenigma obfuscate /path/to/your/module -e "2025-12-31 23:59:59+0530"
Specify custom output directory:
codeenigma obfuscate /path/to/your/module -o custom_output
Version Information
To check the installed version:
codeenigma version
Contributing
Contributions are welcome! This is a complete free and open-source project. If you have any suggestions or find any bugs, please open an issue.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Built with ❤️ using Python
- Uses cryptography for secure encryption
- Uses Cython for compiling the runtime
- Logo Credits, Claude 🫡
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codeenigma-1.2.0.tar.gz.
File metadata
- Download URL: codeenigma-1.2.0.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.2 CPython/3.10.7 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a35c705291567c0d30745f24f71524944e90091ef7f80f3dbf656f366fda74df
|
|
| MD5 |
c1021a6cca756d9830a11296fbe96a22
|
|
| BLAKE2b-256 |
a1bb99b654011cb4adc79451406a8e0d89d95809f7e033e224ff5a1685e33043
|
File details
Details for the file codeenigma-1.2.0-py3-none-any.whl.
File metadata
- Download URL: codeenigma-1.2.0-py3-none-any.whl
- Upload date:
- Size: 21.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.2 CPython/3.10.7 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80fd07d53e3c7966e7f6b4b4b6e5eab1152840f3c66406aabdd0072c17022dfc
|
|
| MD5 |
50d456ab93002f02a5ac8e41daa8af32
|
|
| BLAKE2b-256 |
b4baa21efbdd582b37b484a2b14e33a39a10a0dd3e4440a14d630ae52db27a64
|