joewalnes/websocketd
Websocketd
websocketd is a CGI web server and process-to-WebSocket wrapper that transforms command line programs into WebSocket servers by bridging standard input and output streams to remote clients. It functions as a TLS-secured gateway that routes traffic to backend processes, allowing any executable using standard IO to be exposed via a web interface.
The project uses directory-based endpoint mapping to automate the creation of URL paths from local executable files. It employs a process-per-connection model to isolate execution and forwards HTTP request metadata, such as cookies and query parameters, to child processes through environment variables.
The system includes capabilities for serving static web assets, restricting WebSocket upgrades based on origin headers, and limiting concurrent processes to prevent resource exhaustion. It also supports custom HTTP header configuration and transport layer security using SSL certificates.
Features
- Standard IO WebSocket Bridges - Provides a bridge that transforms any command line program using standard input and output into a WebSocket server.
- Protocol Bridges - Bridges a program's standard input and output streams directly to a WebSocket connection for remote interaction.
- Process-to-WebSocket Wrappers - Pipes a local executable's input and output streams to and from remote WebSocket clients.
- WebSocket-Based CLI Exposure - Exposes command line programs as WebSocket servers for remote interaction through a web browser.
- Standard IO to WebSocket Bridging - Connects a program's standard input and output to WebSockets for real-time data streaming and remote control.
- Transport Layer Security - Secures socket connections using HTTPS and SSL certificates to encrypt traffic between clients and the server.
- CGI Script Execution - Provides the ability to execute local scripts and return their output as HTTP responses via the CGI standard.
- Protocol Upgrades - Handles the handshake protocol to upgrade standard HTTP requests into persistent bidirectional WebSocket streams.
- Executable-to-WebSocket Proxying - Wraps existing executables with a WebSocket layer to enable real-time data streaming and remote process execution.
- Process-Per-Connection Architectures - Employs a process-per-connection model to isolate execution and manage state for every WebSocket client.
- Session Environment Variable Exporters - Exposes HTTP request headers and client metadata to child processes via session-specific environment variables.
- Origin Validators - Verifies the Origin header during the WebSocket handshake to prevent unauthorized protocol upgrades.
- TLS/SSL Configurations - Secures socket connections using SSL/TLS encryption to protect data transmission.
- TLS-Secured WebSocket Gateways - Provides a TLS-secured gateway for routing traffic to backend processes with origin restriction.
- Process Pool Limiters - Caps the number of simultaneous child processes executed by handlers to prevent system resource exhaustion.
- Filesystem-to-URL Endpoint Mapping - Automates the creation of URL paths by mapping executable files in a local directory to unique endpoints.
- Environment Variable Metadata Forwarding - Forwards remote host, cookies, and query parameters to backend processes through standard environment variables.
- Network Utilities - Turns standard input/output programs into WebSocket servers.
- Communication and Real-time - A tool to turn CLI programs into WebSocket servers.
