pyobfus

pyobfus

Modern Python Code Obfuscator

A Python code obfuscator built with AST-based transformations for Python 3.8+. Provides reliable name mangling, string encoding, and code protection features.

Features

✅ Free Edition

The following features are fully implemented and available in the current version:

• 🆕 Cross-File Obfuscation (v0.2.0): Consistent name obfuscation across multiple files

  • Automatic import statement rewriting
  • __all__ list updates with obfuscated names
  • Global symbol table with collision detection
  • Two-phase obfuscation pipeline (Scan → Transform)
  • Preview mode with --dry-run flag

• Name Mangling: Rename variables, functions, classes, and class attributes to obfuscated names (I0, I1, I2...)

• Comment Removal: Strip comments and docstrings

• String Encoding: Base64 encoding for string literals with automatic decoder injection

• Parameter Preservation: Preserve function parameter names for keyword argument compatibility (--preserve-param-names)

• Multi-file Support: Obfuscate entire projects with preserved import relationships

• File Filtering: Exclude files using glob patterns (test files, config files, etc.)

• Configuration Files: YAML-based configuration for repeatable builds

• Selective Obfuscation: Preserve specific names (builtins, magic methods, custom exclusions)

🔒 Pro Edition (Available Now)

The following advanced features are available with a Pro license:

• String Encryption (v0.1.6+)

  • AES-256 encryption for strings
  • Runtime decryption with injected decoder
  • Automatic key generation

• Anti-Debugging (v0.1.6+)

  • Debugger detection checks injected into functions
  • Multiple detection methods (sys.gettrace, sys.settrace)
  • Configurable behavior

• Control Flow Flattening (v0.3.0+)

  • State machine transformation for if/else/elif
  • For/while loop flattening
  • Nested structure support
  • CLI: --control-flow

• Dead Code Injection (v0.3.0+)

  • Insertion of unreachable code paths
  • Four strategies: after-return, false branches, opaque predicates, decoy functions
  • CLI: --dead-code

• License Embedding (v0.3.0+)

  • Embed expiration dates: --expire 2025-12-31
  • Machine binding: --bind-machine
  • Run count limits: --max-runs 100
  • Offline verification - no external dependencies

• Configuration Presets (v0.3.0+)

  • --preset trial - 30-day time-limited version
  • --preset commercial - Maximum protection with machine binding
  • --preset library - For pip-distributable libraries
  • --preset maximum - Highest security with all protections
  • --list-presets - View all presets

See ROADMAP.md for the full feature timeline.

Try Pro Features FREE

Try all Pro features for 5 days - no registration or credit card required!

# Start your free trial
pyobfus-trial start

# Check trial status
pyobfus-trial status

# Use Pro features during trial
pyobfus input.py -o output.py --level pro

What's included in the trial:

• Control flow flattening (--control-flow)
• AES-256 string encryption (--string-encryption)
• Anti-debugging protection (--anti-debug)
• Dead code injection (--dead-code)
• License embedding (--expire, --bind-machine, --max-runs)
• Configuration presets (--preset trial/commercial/library/maximum)
• Unlimited files and lines of code

After your trial, purchase a license to continue using Pro features.

Purchase Professional Edition

Pro Edition Features:

• 🔀 Control Flow Flattening (v0.3.0+)
• 🧩 Dead Code Injection (v0.3.0+)
• 🔐 AES-256 String Encryption
• 🛡️ Anti-Debugging Checks
• 📅 License Embedding (v0.3.0+) - Expiration, machine binding, run limits
• ⚡ Configuration Presets (v0.3.0+) - One-command setup
• 🔄 Lifetime Updates
• 💻 Up to 3 devices per license
• 📧 Priority Email Support

Price: $45.00 USD (one-time payment)

How to Purchase

Visit our purchase page: pyobfus.github.io/purchase for detailed information and secure checkout.

Quick purchase: 🚀 Buy Now - Direct checkout link (Instant delivery • 30-day money-back guarantee)

3-Step Purchase Process:

• Complete Secure Checkout (Stripe)

  • Click the buy link above or visit the purchase page
  • Enter your email (for license delivery)
  • Complete payment securely via Stripe

• Receive License Key

  • License key delivered to your email within minutes
  • Format: PYOB-XXXX-XXXX-XXXX-XXXX
  • Check Spam/Junk folder if not in inbox

• Activate License

  pip install --upgrade pyobfus
  pyobfus-license register PYOB-XXXX-XXXX-XXXX-XXXX
  pyobfus-license status
  

• Start Using Pro Features

  # Quick start with presets
  pyobfus src/ -o dist/ --preset commercial   # Maximum protection
  pyobfus src/ -o dist/ --preset trial        # 30-day trial version
  pyobfus src/ -o dist/ --preset library      # For pip distribution
  
  # Individual features
  pyobfus input.py -o output.py --string-encryption
  pyobfus input.py -o output.py --anti-debug
  pyobfus input.py -o output.py --control-flow
  pyobfus input.py -o output.py --dead-code
  
  # License restrictions
  pyobfus src/ -o dist/ --expire 2025-12-31 --bind-machine --max-runs 100
  
  # All Pro features
  pyobfus input.py -o output.py --string-encryption --anti-debug --control-flow --dead-code
  

Support: If you encounter any issues, contact [e-mail] with your license key.

Legal & Policies

By purchasing pyobfus Professional Edition, you agree to our:

• Terms of Service & EULA - License agreement and usage terms
• Refund Policy - 30-day money-back guarantee, no questions asked
• Privacy Policy - GDPR compliant, we protect your data

Quick Start

Installation

From PyPI (recommended):

pip install pyobfus

From source (for development):

git clone https://github.com/zhurong2020/pyobfus.git
cd pyobfus
pip install -e .

Basic Usage

# Obfuscate a single file
pyobfus input.py -o output.py

# Obfuscate a directory (cross-file mode - default in v0.2.0+)
pyobfus src/ -o dist/

# Preview obfuscation without writing files (v0.2.0+)
pyobfus src/ -o dist/ --dry-run

# Legacy single-file mode (v0.2.0+)
pyobfus src/ -o dist/ --no-cross-file

# With configuration file
pyobfus src/ -o dist/ --config pyobfus.yaml

# Preserve parameter names for keyword arguments (v0.1.6+)
pyobfus src/ -o dist/ --preserve-param-names

# Verbose output with progress indicators (v0.2.0+)
pyobfus src/ -o dist/ --verbose

Example

Before obfuscation:

def calculate_risk(age, score):
    """Calculate risk factor."""
    risk_factor = 0.1
    if score > 100:
        risk_factor = 0.5
    return age * risk_factor

patient_age = 55
patient_score = 150
risk = calculate_risk(patient_age, patient_score)
print(f"Risk score: {risk}")

After obfuscation:

def I0(I1, I2):
    I3 = 0.1
    if I2 > 100:
        I3 = 0.5
    return I1 * I3
I4 = 55
I5 = 150
I6 = I0(I4, I5)
print(f'Risk score: {I6}')

Note: Variable names (I0, I1, etc.) may vary slightly depending on code structure, but functionality is preserved.

Configuration

Quick Start with Templates

Generate a configuration template for your project type:

# For Django projects
pyobfus --init-config django

# For Flask projects
pyobfus --init-config flask

# For Python libraries
pyobfus --init-config library

# For general projects
pyobfus --init-config general

This creates a pyobfus.yaml file with sensible defaults for your project type.

Validate Configuration

Check your configuration file for errors before use:

pyobfus --validate-config pyobfus.yaml

The validator checks for:

• YAML syntax errors
• Invalid configuration options
• Common typos (e.g., exclude_pattern -> exclude_patterns)
• Pro features used with community level

Auto-Discovery

When you run pyobfus without -c, it automatically searches for:

• pyobfus.yaml
• pyobfus.yml
• .pyobfus.yaml
• .pyobfus.yml

Manual Configuration

Create pyobfus.yaml:

obfuscation:
  level: community
  exclude_patterns:
    - "test_*.py"
    - "**/tests/**"
    - "__init__.py"
  exclude_names:
    - "logger"
    - "config"
    - "main"
  remove_docstrings: true
  remove_comments: true

exclude_names Behavior

The exclude_names option preserves specified names from being renamed during obfuscation:

obfuscation:
  exclude_names:
    - MyPublicClass      # Name preserved, but strings inside are still encoded
    - exported_function  # Name preserved for external callers

Important: exclude_names only affects name obfuscation, not string encoding:

# Original
SECRET_KEY = "admin-password-123"

# With exclude_names: [SECRET_KEY] and string_encoding: true
SECRET_KEY = _decode_str('YWRtaW4tcGFzc3dvcmQtMTIz')
# ✅ Name 'SECRET_KEY' is preserved
# ✅ String content is still encoded (Base64)

Use cases:

• Preserve names for public APIs that external code imports
• Keep class/function names for debugging while still protecting string content
• Maintain compatibility with external frameworks expecting specific names

File Filtering

Exclude patterns support glob syntax:

• test_*.py - Exclude files starting with "test_"
• **/tests/** - Exclude all files in "tests" directories
• **/__init__.py - Exclude all __init__.py files
• setup.py - Exclude specific files

See pyobfus.yaml.example for more configuration examples.

Architecture

pyobfus uses Python's ast module for syntax-aware transformations:

• Parser: Parse Python source to AST
• Analyzer: Build symbol table with scope analysis
• Transformers: Apply obfuscation techniques (name mangling, string encoding, etc.)
• Generator: Generate obfuscated Python code

This approach ensures:

• Syntactically correct output
• Proper handling of Python scoping rules
• Support for modern Python features (f-strings, walrus operator, etc.)

Development

Setup

git clone https://github.com/zhurong2020/pyobfus.git
cd pyobfus
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -e ".[dev]"

Testing

# Run unit tests
pytest tests/ -v

# With coverage
pytest tests/ -v --cov=pyobfus --cov-report=html

# Run integration tests
pytest integration_tests/ -v

Integration Testing Framework (v0.1.6+): Test pyobfus on real-world code without uploading to PyPI. See INTEGRATION_TESTING.md for details.

Code Quality

# Format code
black pyobfus/

# Type checking
mypy pyobfus/

# Linting
ruff check pyobfus/

Use Cases

Protecting Proprietary Algorithms

Obfuscate sensitive business logic before distributing Python applications.

Educational Purposes

Demonstrate code protection concepts and obfuscation techniques.

Intellectual Property Protection

Add an additional layer of protection for commercial Python software.

Limitations

Current Limitations

• Keyword Arguments (✅ Resolved in v0.1.6): By default, parameter names are obfuscated, which breaks keyword arguments. Solution: Use the --preserve-param-names flag to preserve parameter names while still obfuscating function bodies.

  Example:

  # Before obfuscation
  def process(data_path, output_dir):
      temp_file = data_path + ".tmp"
      return temp_file
  
  result = process(data_path='./data', output_dir='./output')  # ✅ Works
  
  # After obfuscation (default behavior)
  def I0(I1, I2):
      I3 = I1 + ".tmp"
      return I3
  
  result = process(data_path='./data', output_dir='./output')  # ❌ TypeError!
  
  # After obfuscation (with --preserve-param-names)
  def I0(data_path, output_dir):
      I3 = data_path + ".tmp"
      return I3
  
  result = I0(data_path='./data', output_dir='./output')  # ✅ Works!
  

  When to use --preserve-param-names:

  • Public API functions/libraries where keyword arguments are used by clients
  • Functions with many parameters where keyword arguments improve readability
  • Code that relies heavily on keyword-only arguments (def func(*, kwonly))

  Trade-off: Parameter names reveal some information about the function's interface, but function bodies and local variables are still fully obfuscated.

• Cross-file imports: ✅ Resolved in v0.2.0 with full cross-file obfuscation support

• Dynamic code: eval(), exec() with obfuscated code may require adjustments

• Debugging: Obfuscated code is harder to debug (by design)

• Performance: Some obfuscation techniques may impact runtime performance

Recommendations

• Test obfuscated code thoroughly before deployment
• Keep original source in version control
• Use configuration files for reproducible builds
• For public APIs, use --preserve-param-names to maintain keyword argument compatibility
• Consider combining with other protection methods (compilation, etc.)

Technical Details

• Python Support: 3.8, 3.9, 3.10, 3.11, 3.12
• Naming Scheme: Index-based (I0, I1, I2...) - simple and effective
• Architecture: Modular transformer pipeline with two-phase cross-file obfuscation
• Testing: 302 tests, 69% coverage, multi-OS CI/CD

Frequently Asked Questions

Is pyobfus Right for Me?

Use pyobfus if you:

• Need to protect proprietary algorithms before distributing Python applications
• Want a tool that "just works" without DLL conflicts or native dependencies
• Prefer transparent pricing without hidden trial limitations
• Support open-source software with optional paid features

How do I obfuscate Python code?

# Install
pip install pyobfus

# Obfuscate a single file
pyobfus script.py -o script_obf.py

# Obfuscate an entire project
pyobfus src/ -o dist/

# Preview without writing files
pyobfus src/ -o dist/ --dry-run

Will my code still work after obfuscation?

Yes, pyobfus guarantees 100% functional equivalence. The obfuscated code produces identical outputs to your original code. We use Python's AST (Abstract Syntax Tree) for syntax-aware transformations, ensuring syntactically correct output.

Does obfuscated code run slower?

Minimal impact:

• Name mangling: Zero runtime cost (just renamed identifiers)
• String encoding (Base64): ~0.1ms per string at startup
• String encryption (AES-256, Pro): ~0.5ms per string at startup

Can I obfuscate Django/Flask projects?

Yes! Use our built-in templates:

# Django
pyobfus --init-config django

# Flask
pyobfus --init-config flask

# Then run obfuscation
pyobfus src/ -o dist/ -c pyobfus.yaml

What Python versions are supported?

pyobfus supports Python 3.8, 3.9, 3.10, 3.11, and 3.12. Generated code is compatible with all these versions regardless of which version you use to run pyobfus.

PyArmor vs pyobfus: Which should I choose?

Feature	pyobfus	PyArmor
Price	$45 (Pro)	$89 (Pro)
Free tier	Clear limits (5 files/1000 LOC)	Vague "trial" limitations
Open source	Yes (Core: Apache 2.0, Pro: Proprietary)	No
Native dependencies	None (pure Python output)	Requires runtime library
Python 3.12 support	Yes	Yes

Choose pyobfus if: You want transparent pricing, open-source trust, and simpler deployment without native dependencies.

See our detailed comparison for more information.

What if obfuscation breaks my code?

• Use --dry-run to preview changes before writing files
• Use --preserve-param-names if you rely on keyword arguments
• Add exclusions in pyobfus.yaml for names that must stay unchanged
• Report issues on GitHub - we fix bugs quickly!

Can obfuscated code be reversed?

Name mangling is irreversible - original variable names cannot be recovered. However, code logic remains intact (this is true for all obfuscators). For stronger protection, use Pro features:

• AES-256 encryption for strings
• Anti-debugging checks to prevent analysis

Security Note: String Encryption Limitations

Important: String encryption (AES-256) is designed as a deterrent against casual reverse engineering, not as cryptographic security.

Because obfuscated code must decrypt strings at runtime, the encryption key is necessarily embedded in the output. A determined attacker with access to the obfuscated code can:

• Locate the embedded key
• Extract and decrypt all strings

This is a fundamental limitation of ALL client-side obfuscators (including PyArmor, Nuitka, etc.) - true cryptographic security would require server-side decryption, which is impractical for most use cases.

What string encryption DOES provide:

• ✅ Prevents casual strings or grep searches from revealing sensitive text
• ✅ Increases effort required for reverse engineering
• ✅ Deters non-technical users from extracting information
• ✅ Adds a layer of protection combined with other techniques

What string encryption does NOT provide:

• ❌ Protection against determined reverse engineers
• ❌ Cryptographic security for secrets (use environment variables or secret management instead)
• ❌ DRM-level protection

Recommendation: For sensitive credentials (API keys, passwords), use environment variables or external secret management systems rather than embedding them in code.

How is pyobfus different from Cython/Nuitka?

Tool	Approach	Output
pyobfus	AST transformation	.py files (pure Python)
Cython	Compile to C	.so/.pyd (platform-specific)
Nuitka	Compile to executable	Binary (platform-specific)

Choose pyobfus if: You need cross-platform .py files without compilation overhead.

Documentation

For Users

• Installation & Quick Start - Get started in minutes
• Configuration Guide - YAML configuration and file filtering
• Examples - Working code examples demonstrating features
• Use Cases - Real-world application scenarios

For Developers

• Project Structure - Codebase architecture and development workflow
• Contributing Guide - How to contribute code and documentation
• Development Roadmap - Planned features and timeline
• Changelog - Version history and release notes

Community & Support

• GitHub Issues - Bug reports and feature requests
• GitHub Discussions - Questions, ideas, and community help
• Security Policy - How to report security vulnerabilities

Legal & License

• Dual License Model:
  • pyobfus (Core): Apache 2.0 - Free and open source
  • pyobfus_pro (Pro): Proprietary - Requires paid license

Support the Project

If you find pyobfus helpful, consider supporting its development:

Buy Me A Coffee

Your support helps maintain and improve pyobfus. Thank you!

Acknowledgments

• Inspired by Opy's AST-based approach
• Clean room implementation - no code copying