Skip to main content

PayloadBuilder X - A modular payload compiler framework

Project description

PayloadBuilder X (PBX) v0.0.2

PayloadBuilder X (PBX) is an experimental modular payload generator designed for flexibility and future extensibility. This is a very early beta release, mainly for testing and internal development.


Project Status: Alpha / Experimental

This project is in pre-release. Many features are unimplemented or incomplete. Use it only for testing and experimentation.


What Works (v0.0.2)

  • Basic payload block loading from /builder/blocks/
  • Standardized block naming convention
  • METADATA structure for each block
  • Early-stage compiler.py logic
  • Preliminary support for plugin .pbx files (non-functional)

Directory Structure

/builder/
├── compiler.py    # Core build logic
├── loader.py      # Block discovery and loading
├── blocks/
│ ├── base/
│ │ └── reverse_shell.macos.python.base.short.py.py
│ ├── stealth/
│ │ └── obfuscate_vars.all.python.stealth.default.py
│ ├── persistence/
│ │ └── mac_launch_agent.macos.python.persistence.default.py

Block File Format

Each payload block file must follow this format:

<category><name><platform><language><variant>.py

Each must define a METADATA dictionary:

METADATA = {
    "name": "example",
    "platform": "win",
    "language": "py",
    "variant": "default",
    "author": "YourName",
    "description": "Example base block.",
    "version": "0.0.1"
}

Known Limitations (v0.0.2)

  • Single-block only: Pipelines with multiple stages (e.g., base → stealth → addon) are not yet supported.
  • Platform-specific only: Currently limited to hardcoded platforms (e.g., Windows); cross-platform behavior is unimplemented.
  • No validation: Block metadata is assumed to be correct; no schema enforcement or conflict detection.
  • Plugins inactive: .pbx plugin files are recognized but not executed.
  • No output formatting: Payloads are raw code snippets with no wrapping, obfuscation, or encoding.
  • No dependency handling: Blocks do not yet declare or resolve external requirements.

Roadmap

PBX is in early development. Here are the upcoming goals and improvements planned for future versions:

v0.0.2 (Current)

  • Single-block compilation
  • Basic block structure and metadata
  • Initial compiler.py and loader.py prototypes

Planned for v0.0.3+

  • Support for multi-stage build pipelines (e.g., base → stealth → addon)
  • Cross-platform payload generation support
  • Plugin execution system for .pbx files
  • Output formatting and payload wrapping
  • Block dependency resolution
  • Obfuscation modules and modifier system
  • Metadata validation and schema checking
  • Logging and error reporting
  • Test suite (unit + integration)
  • Developer documentation and templates

Contributing

Contributions are welcome and encouraged!

How to Contribute:

  • Submit new payload blocks using the proper naming and metadata format
  • Report issues or suggest features in the issue tracker
  • Review and improve core files (compiler.py, loader.py, etc.)

PBX is under active development. Expect frequent changes to structure and API.


Acknowledgments

Thanks to early testers and contributors experimenting with the concept and structure. Your feedback shapes PBX’s direction.


License

This project is licensed under a MIT-Based License with PBX Security Conditions.
Use of this software is subject to specific Conditions of Use regarding lawful, ethical, and responsible security practices.

See the LICENSE file for full details.


Conditions of Use

PayloadBuilder X is intended solely for lawful, ethical, and responsible security research and educational purposes.

By using this software, you agree to comply with the Conditions of Use defined in the project's license.

Unauthorized use of this software for malicious purposes — including the development or deployment of malware, unauthorized system access, or any illegal activity — is strictly prohibited.

Violation of these terms may result in legal consequences and immediate termination of your license to use this software.


PBX is intended for educational and research purposes only. Use responsibly and only in controlled environments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pbx-0.0.2.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pbx-0.0.2-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file pbx-0.0.2.tar.gz.

File metadata

  • Download URL: pbx-0.0.2.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for pbx-0.0.2.tar.gz
Algorithm Hash digest
SHA256 77407c71827b2e35918c974e41b1ccba30e1b3a176d75f018414aad046ad9df6
MD5 7bc007d8df2fe80fc27036844d4eec0e
BLAKE2b-256 8f7c1bc57b77331f795067c41f1da8ad9340ba444d52a6ca00ce7b87717e12a6

See more details on using hashes here.

File details

Details for the file pbx-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pbx-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for pbx-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5920cf11779bda53b8ef70ec1e573153ed3f93ab708bf8ba1d8cf7a62c6b4f34
MD5 0e24f307aa439a59575907d84a0a0fb1
BLAKE2b-256 9042387e95c56c212a0211c71cbe7d4663c3f997853c55a4285fe6dc71c96443

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page