novnc/websockify
Websockify
Websockify is a WebSocket-to-TCP proxy and tunneling server that enables web browsers to communicate with servers or applications that only support standard TCP connections. It functions as a network bridge and connection broker, translating bidirectional WebSocket frames into raw TCP packets to facilitate remote browser access to backend services.
The system acts as a secure socket gateway that supports multi-tenant socket routing, allowing multiple clients to be directed to different backend targets based on unique URL tokens or hostnames. It secures data in transit by wrapping connections in SSL/TLS encryption and utilizes a plugin-based system to authenticate users before establishing backend connections.
Additional capabilities include a multi-process worker model for scaling concurrent connection loads and the ability to intercept local processes to redirect network output into the proxy stream. The project also provides tools for recording raw network byte streams for debugging and can serve static web content from a local directory on the same port as the proxy.
The software can be operated as a daemon to maintain persistent connectivity without an active terminal session.
Features
- WebSocket Proxy Tunnels - Provides a proxy that translates WebSocket traffic into raw TCP packets to enable browser communication with non-WebSocket servers.
- TCP Proxies - Implements a TCP proxy that converts WebSocket traffic from browsers into standard TCP packets for communication with backend servers.
- Tenant Request Routing - Directs incoming WebSocket connections to different backend targets based on unique tokens or hostnames.
- Multi-Target Connection Brokers - Provides a routing system that connects clients to specific backend targets based on request hostnames or URL tokens.
- Multi-Target Socket Routing - Directs multiple clients to different backend targets based on unique URL tokens or hostnames.
- Secure Socket Wrappers - Wraps unencrypted TCP traffic in SSL or TLS to ensure secure data transmission between browsers and servers.
- Token-Based Target Routing - Maps unique URL tokens or hostnames to specific backend TCP destinations to multiplex multiple targets on one port.
- WebSocket-to-TCP Translation - Translates bidirectional WebSocket frames into raw TCP streams to allow browser communication with non-WebSocket servers.
- Connection Authentication Mechanisms - Validates client identities using a plugin-based system before allowing the proxy to establish backend TCP connections.
- TLS Session Wrapping - Wraps raw socket traffic in an SSL/TLS encrypted layer using certificates to secure data in transit.
- TLS-Secured WebSocket Gateways - Acts as a gateway that authenticates users and encrypts data before proxying WebSocket traffic to internal TCP ports.
- SSL/TLS Connection Security - Wraps raw socket traffic in an SSL/TLS encrypted layer using certificates to secure data in transit.
- Token-Based Target Mapping - Connects clients to specific backend targets based on unique tokens provided in the URL or request hostname.
- Process Scaling - Uses a multi-process worker model to distribute concurrent connection loads across multiple CPU cores.
- Local Process Bridging - Provides the ability to launch local processes and intercept their network calls to send WebSocket traffic directly to the program's TCP port.
- Process-Level Interception - Launches target applications as subprocesses and redirects their network output directly into the proxy stream.
- Proxy Connection Authentications - Utilizes a plugin-based system to authenticate users before establishing backend TCP connections.
- Remote Access Tunnels - Enables web-based interfaces to interact with local processes or remote services via secure WebSocket tunnels.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
