Websocat

Websocat is a specialized set of command-line tools for WebSocket communication, acting as a client, server, and stream processor. It provides a terminal-based interface for connecting to WebSocket servers, hosting secure WebSocket servers, and bridging data between WebSockets and other network transports.

The project distinguishes itself by functioning as a bidirectional network relay, allowing the routing of data between WebSocket streams, TCP sockets, UNIX sockets, and standard system input and output. It includes specialized implementations for SOCKS5 and HTTP proxying, as well as a stream processor capable of transforming WebSocket messages into line-based or binary records for use with external programs.

The toolset covers a broad range of networking capabilities, including secure communication via TLS and symmetric encryption, protocol bridging, and network debugging through traffic inspection. It also supports server mocking, automatic connection re-establishment, and the exposure of performance metrics on dedicated ports.

The project is packaged as a lightweight Docker container image for deployment across different environments.

Features

WebSocket Clients - Ships a terminal-based client for establishing and managing bidirectional WebSocket connections.

WebSocket Security - Establishes secure, encrypted WebSocket connections using TLS or static symmetric keys.

Command Piping - Pipes the standard input and output of external command-line programs directly to a network connection.

Bidirectional Protocol Bridging - Forwards data bidirectionally between different socket types, bridging diverse network endpoints.

Pluggable Transport Layers - Utilizes a pluggable transport layer to seamlessly relay data between TCP, UNIX sockets, and WebSockets.

Websocket Connection Managers - Establishes secure or insecure connections to remote WebSocket servers.

Port-Based WebSocket Listeners - Hosts WebSocket servers listening on TCP ports, UNIX sockets, or abstract-namespaced sockets.

Secure - Provides a command-line listener that accepts secure WebSocket connections using PKCS#12 certificates.

Secure Server Implementations - Provides a command-line utility to host secure WebSocket servers using PKCS#12 certificates.

Event-Driven Networking - Implements a high-performance event-driven networking model using non-blocking I/O for concurrent connections.

Process-to-WebSocket Wrappers - Pipes an external program's standard input and output streams directly to a WebSocket connection.

Bidirectional Stream Proxying - Provides bidirectional data stream proxying between remote listeners and local clients.

Standard IO WebSocket Bridges - Bridges the standard input and output of local processes to WebSocket connections.

TCP and Unix Socket Listeners - Connects to and listens on TCP and UNIX sockets for raw bidirectional data exchange.

WebSocket Terminal Clients - Provides a terminal-based interface to connect to WebSocket servers for testing and automation.

Transport Mapping - Proxies data by mapping TCP connections to WebSocket connections and vice versa.

File and Console I/O - Facilitates interaction with the console by reading and writing to standard system input and output streams.

WebSocket Protocol Relays - Bridges and routes data bidirectionally between WebSocket connections, TCP sockets, and UNIX sockets.

Streaming Data Transformers - Provides a transformation pipeline to modify data streams by adding timestamps or converting messages to lines.

Broadcast Messaging Channels - Duplicates replies from a single inner connection to all currently connected downstream clients.

Automatic Reconnection - Automatically re-establishes underlying connections after encountering errors or end-of-file signals.

Direct-to-Network File Streaming - Streams data from local files directly to network connections or logs traffic to disk using append operations.

SOCKS5 Proxies - Routes WebSocket connections through SOCKS5 or HTTP proxies to bypass network restrictions.

SOCKS5 Proxy Tunneling Clients - Acts as a networking client that tunnels WebSocket traffic through SOCKS5 or HTTP proxies to bypass restrictions.

Text and Binary Message Exchanges - Supports bidirectional transmission and conversion between binary bytes and UTF-8 encoded text messages.

Proxy-Routed - Routes WebSocket connections through HTTP or SOCKS5 proxies using the CONNECT method to bypass network restrictions.

Stream Processors - Filters and transforms WebSocket data streams into line-based or binary records for external tools.

WebSocket Utilities - Includes tools for inspecting raw traffic and protocol frames to debug WebSocket communication issues.

Line-Based Record Processing - Translates WebSocket messages into line-based records for compatibility with shell-based text processing tools.

TLS Session Wrapping - Wraps raw socket connections with TLS using PKCS#12 certificates for secure communication.

Message Encryption - Implements message-level encryption using the ChaCha20-Poly1305 algorithm for secure data transmission.

Symmetric Encryption - Secures raw byte streams using symmetric encryption with the ChaCha20-Poly1305 algorithm.

TLS Traffic Encryption - Provides capabilities to wrap connections in TLS encryption or accept secure connections via certificates.

Network Analysis and Simulation - CLI client for WebSocket debugging and interaction.

viwebsocat

Features

Star history