Skip to content

External Listener

The external listener enables integration with external C2 frameworks through WebSocket connections. Instead of handling agent connections directly, it manages communication with other C2 systems, allowing unified control of agents across multiple frameworks.

External listener integration diagram

Configuration

The table below documents all available configuration parameters:

Attribute Explanation
host Interface where the external listener binds (default: 0.0.0.0).
port Port number on which the listener accepts WebSocket connections (required).
contextPath URL path prefix for the WebSocket endpoint (default: /). Change this if you need to host the listener under a subpath.
restrictDataToUser Controls whether users can see and modify other users' agents and commands via the WebSocket connection. Note: This restriction does not apply to API operations.
requireJwtAuthentication Requires JWT authentication token (obtainable via C2 API login) for WebSocket connections.