Skip to main content

WebSocket bridge connecting local PentestGPT to GPTree

Project description

GPTree PentestGPT Bridge

WebSocket bridge that connects your local PentestGPT installation to GPTree. The bridge runs on your machine and connects outbound only. No exposed ports, no inbound firewall rules.

Quick Start

1. Generate a token

Go to GPTree > Settings > PentestGPT and click Generate Token.

2. Install

pip install gptree-pentestgpt-bridge

3. Run

export GPTREE_TOKEN=pt_your_token_here

pentestgpt-bridge

The bridge auto-fetches connection details from GPTree using your token. No additional configuration is needed.

Optional: Install PentestGPT SDK

Without the PentestGPT SDK, the bridge runs in stub mode (returns sample responses so you can verify the connection works). Install the SDK for real pentesting:

pip install pentestgpt

Environment Variables

Variable Default Description
GPTREE_URL https://gp-tree.com GPTree server URL (only change for self-hosted instances)
GPTREE_TOKEN (required) Bridge token from GPTree settings
PENTESTGPT_MAX_ITERATIONS 300 Max agent iterations per request
PENTESTGPT_WORKSPACE ./workspace Working directory for tool output

How It Works

  1. The bridge authenticates with GPTree using your token
  2. GPTree returns WebSocket connection details automatically
  3. The bridge subscribes to your private channel via WebSocket
  4. When you send a message in GPTree using a PentestGPT model, the bridge receives the work
  5. PentestGPT runs locally, streaming results back to GPTree in real time
  6. Findings (vulnerabilities, open ports, etc.) are cataloged automatically

Requirements

  • Python 3.10 or later
  • A GPTree account with PentestGPT enabled
  • (Optional) PentestGPT SDK for real scanning capabilities

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

gptree_pentestgpt_bridge-0.2.0.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

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

gptree_pentestgpt_bridge-0.2.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file gptree_pentestgpt_bridge-0.2.0.tar.gz.

File metadata

  • Download URL: gptree_pentestgpt_bridge-0.2.0.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for gptree_pentestgpt_bridge-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4e601230922385de26baaac0294210259fb5b8667055f4b278ed223644011390
MD5 ffb175baa8790ddc3b0e2583d4793360
BLAKE2b-256 3879e2b1109e3ac874a25becaec51a6464ddc7e36ca87eb9adff5faac8284805

See more details on using hashes here.

File details

Details for the file gptree_pentestgpt_bridge-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gptree_pentestgpt_bridge-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8455f2c9fab45e3884627ba203da661a06aeb23d6d3aef16f37a64c76a9c2f54
MD5 1f592daeda3b9366935cab7d374f593a
BLAKE2b-256 26af9e78d486e4c0817413ea797e593c99ffa08285c506f822833f20ca884f99

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