This is a websocket to tcp proxy, written in node.js. It is dynamic and will proxy to various tcp servers.
npm install wsproxy -g
wsproxy [-p PORT] [-t THREADS (# of threads to spawn)] [-s ENABLE_SSL] [-k KEY_FILE] [-c CERT_FILE]
-pPort to bind wsProxy to- If no
portis specified it will default toprocess.env.PORTor port 5999.
- If no
-aList of allowed servers to proxy to- By default wsProxy will proxy to any ip:port, this is a major risk, since malicous users may use your wsProxy server for illegal activity, or any other use other then connecting to your athena server.
- The list of IP:PORT's should be separate by comma! Ex:
wsproxy -a 127.0.0.1:6900,127.0.0.1:6121,127.0.0.1:5121
- Note: Use the same IP's you configured your server address at ROConfig at roBrowser.
--proxy-protocolStart every TCP connection with a PROXY protocol v2 header carrying the client's address- The address is the last
X-Forwarded-Forentry (appended by the reverse proxy in front of wsProxy), else the socket peer. Only enable it when every request reaches wsProxy through such a proxy, and only for targets that expect PROXY (TitanRO: the Envoy Gateway edge). AlsoWSPROXY_PROXY_PROTOCOL=1.
- The address is the last
--connect-hostDial this host instead of the requested one, on the requested port (alsoWSPROXY_CONNECT_HOST)- The allow-list still checks the requested
host:port. TitanRO uses it to reach the Envoy Gateway edge through its in-cluster Service: dialing the edge's public IP from inside the cluster goes through the DO load balancer on some nodes (which adds a second PROXY header) and straight to Envoy on others.
- The allow-list still checks the requested
--connect-mapDial a differenthost:portfor specific requested ones (alsoWSPROXY_CONNECT_MAP)- Comma-separated
requested-host:port=dial-host:portentries, e.g.test.titanro.net:6903=login.test-season.svc.cluster.local:6900. An entry takes precedence over--connect-host; the allow-list still checks the requestedhost:port. TitanRO uses it to reach the game servers' Services directly instead of going back through the edge.
- Comma-separated
-tNumber of cpu cores that wsProxy should use-sEnable SSL-kPath to ssl key file-cPath to ssl cert file
- Use
wsproxy --helpfor a list of available commands.
When connecting to this websocket you will give it an IP:PORT uri, for example:
ws://websocket.example.com:5999/127.0.0.1:6900
- You can edit allowed.js to only allow proxy to certain IP:PORT
- Note: if you pass in the
-aor--allowoption when starting thewsproxythis file will be ignored.
- Note: if you pass in the
- We will soon release a version, with better standards for this.
- Simply require and extend current files from the
/srcfolder, once done, require them on wsProxy/index.js. - BE CAREFUL, MODULES NEED TO BE LIGHTWEIGHT, LIMIT YOURSELF TO SIMPLE I/O OPERATIONS, DON'T BLOCK, AND CREATE LITTLE GARBAGE!
- Don't forget that node.js is single threaded, cpu intensive blocks of code will block the entire proxy!
- Don't create to much garbage, or the garbage collector will also block for extended periods of time, thus creating "lag" for the users.
This was created for and by the roBrowser project.
- Einaros/ws for providing the websocket middleware