ws2connect

WS2Connect

Expose any TCP service over websocket.

• Single binary
• Pre-built for all major OS (see installation)
• Few resource consumption
• Blazing fast
• Supports multiple endpoints with multiple mappings
• Supports dynamic and static endpoint mappings
• Supports TLS (HTTPS) serving
• Optional Basic or Digest authorization with encrypted (bcrypt or sha) httpasswd file as a secured storage

Examples

• Expose some FIX API (host: example.com:9823) over websocket on http://127.0.0.1:8080/ws path

ws2connect /ws:example.com:9823

• Expose several services

ws2connect /ws:example.com:9823 /another-ws:host:9912

• Change binding to 8888 port

ws2connect -b 0.0.0.0:8888 /ws:example.com:9823

• Server over HTTPS (with server.crt and server.key files)

ws2connect --tls /ws:example.com:9823

• Dynamic and static endpoint mapping together

ws2connect --dynamic /dynamic/ /ws:example.com:9823 /another-ws:host:9912

• Basic authorization

# Create httpasswd file by standard utilities (for ubuntu: sudo apt install apache2-utils)
# Initial file should be created with -c flag
htpasswd -c -B -b auth admin adminPassword
# Add more users (without -c)
htpasswd -B -b auth guest guestPassword
# Start ws2connect with basic authroization and other flags
ws2connect -k basic -p auth /ws:example.com:9823

where:

• -c - creates new file for passwords
• -B - use bcrypt to hash password, so even if file will be stolen no one can recover passwords
• -b - read password from command line argument. Good for example but for safety remove the flag and use STDIN as source of password
• auth - file name for passwords

Usage

Usage:
  ws2connect [OPTIONS] [endpoints]

Application Options:
  -b, --binding=                      HTTP binding address (default: :8080) [$BINDING]
  -t, --timeout=                      Backend connection timeout (default: 15s) [$TIMEOUT]
      --graceful-shutdown=            Delay before server shutdown (default: 15s) [$GRACEFUL_SHUTDOWN]
      --tls                           Enable HTTPS serving with TLS [$TLS]
      --cert-file=                    Path to certificate for TLS (default: server.crt) [$CERT_FILE]
      --key-file=                     Path to private key for TLS (default: server.key) [$KEY_FILE]
  -q, --quiet                         Disable logging [$QUIET]
  -d, --dynamic=                      Dynamic endpoint mapping path [$DYNAMIC]

Authorization:
  -k, --auth.kind=[none|basic|digest] Authorization kind (default: none) [$AUTH_KIND]
      --auth.realm=                   Name of authorization zone (default: Restricted zone) [$AUTH_REALM]
  -p, --auth.htpasswd=                Path to htpasswd (bcrypt or sha) file for user authorization [$AUTH_HTPASSWD]

Help Options:
  -h, --help                          Show this help message

Arguments:
  endpoints:                          Endpoint mapping (/path:address)

Installation

Binary

• From releases page
• From bintray repository for most debian-based distribution (trusty, xenial, bionic, buster, wheezy):

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 379CE192D401AB61
echo "deb https://dl.bintray.com/reddec/ws2connect-debian {distribution} main" | sudo tee -a /etc/apt/sources.list
sudo apt install ws2connect

From source

• Expected Go version at least 1.13 and upper
• go get -v github.com/reddec/ws2connect/cmd/...