Websockify is a WebSocket to TCP proxy/bridge. This allows a browser to connect to any application/server/service. Implementations in Python, C, Node.js and Ruby.
At the most basic level, websockify just translates WebSockets traffic to normal socket traffic. Websockify accepts the WebSockets handshake, parses it, and then begins forwarding traffic between the client and the target in both directions.
News/help/contact
Notable commits, announcements and news are posted to @noVNC
If you are a websockify developer/integrator/user (or want to be) please join the noVNC/websockify discussion group
Bugs and feature requests can be submitted via github issues.
If you want to show appreciation for websockify you could donate to a great non-profits such as: Compassion International, SIL, Habitat for Humanity, Electronic Frontier Foundation, Against Malaria Foundation, Nothing But Nets, etc. Please tweet @noVNC if you do.
WebSockets binary data
Starting with websockify 0.5.0, only the HyBi / IETF 6455 WebSocket protocol is supported. There is no support for the older Base64 encoded data format.
Encrypted WebSocket connections (wss://)
To encrypt the traffic using the WebSocket 'wss://' URI scheme you need to generate a certificate and key for Websockify to load. By default, Websockify loads a certificate file name
self.pem but the --cert=CERT and --key=KEY options can override the file name. You can generate a self-signed certificate using openssl. When asked for the common name, use the hostname of the server where the proxy will be running:openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem
For a self-signed certificate to work, you need to make your client/browser understand it. You can do this by installing it as accepted certificate, or by using that same certificate for a HTTPS connection to which you navigate first and approve. Browsers generally don't give you the "trust certificate?" prompt by opening a WSS socket with invalid certificate, hence you need to have it acccept it by either of those two methods.
If you have a commercial/valid SSL certificate with one ore more intermediate certificates, concat them into one file, server certificate first, then the intermediate(s) from the CA, etc. Point to this file with the
--cert option and then also to the key with --key. Finally, use --ssl-only as needed.Additional websockify features
These are not necessary for the basic operation.
- Daemonizing: When the
-Doption is specified, websockify runs in the background as a daemon process. - SSL (the wss:// WebSockets URI): This is detected automatically by websockify by sniffing the first byte sent from the client and then wrapping the socket if the data starts with '\x16' or '\x80' (indicating SSL).
- Session recording: This feature that allows recording of the traffic sent and received from the client to a file using the
--recordoption. - Mini-webserver: websockify can detect and respond to normal web requests on the same port as the WebSockets proxy. This functionality is activated with the
--web DIRoption where DIR is the root of the web directory to serve. - Wrap a program: see the "Wrap a Program" section below.
- Log files: websockify can save all logging information in a file. This functionality is activated with the
--log-file FILEoption where FILE is the file where the logs should be saved. - Authentication plugins: websockify can demand authentication for websocket connections and, if you use
--web-auth, also for normal web requests. This functionality is activated with the--auth-plugin CLASSand--auth-source ARGoptions, where CLASS is usually one from auth_plugins.py and ARG is the plugin's configuration. - Token plugins: a single instance of websockify can connect clients to multiple different pre-configured targets, depending on the token sent by the client using the
tokenURL parameter, or the hostname used to reach websockify, if you use--host-token. This functionality is activated with the--token-plugin CLASSand--token-source ARGoptions, where CLASS is usually one from token_plugins.py and ARG is the plugin's configuration.
Other implementations of websockify
The primary implementation of websockify is in python. There are several alternate implementations in other languages available in our sister repositories websockify-js (JavaScript/Node.js) and websockify-other (C, Clojure, Ruby).
In addition there are several other external projects that implement the websockify "protocol". See the alternate implementation Feature Matrix for more information.
Wrap a Program
In addition to proxying from a source address to a target address (which may be on a different system), websockify has the ability to launch a program on the local system and proxy WebSockets traffic to a normal TCP port owned/bound by the program.
The is accomplished with a small LD_PRELOAD library (
rebind.so) which intercepts bind() system calls by the program. The specified port is moved to a new localhost/loopback free high port. websockify then proxies WebSockets traffic directed to the original port to the new (moved) port of the program.
The program wrap mode is invoked by replacing the target with
-- followed by the program command line to wrap.`./run 2023 -- PROGRAM ARGS`
The
--wrap-mode option can be used to indicate what action to take when the wrapped program exits or daemonizes.
Here is an example of using websockify to wrap the vncserver command (which backgrounds itself) for use with noVNC:
`./run 5901 --wrap-mode=ignore -- vncserver -geometry 1024x768 :1`
Here is an example of wrapping telnetd (from krb5-telnetd). telnetd exits after the connection closes so the wrap mode is set to respawn the command:
`sudo ./run 2023 --wrap-mode=respawn -- telnetd -debug 2023`
The
wstelnet.html page in the websockify-js project demonstrates a simple WebSockets based telnet client (use 'localhost' and '2023' for the host and port respectively).Installing websockify
Download one of the releases or the latest development version, extract it and run
python setup.py install as root in the directory where you extracted the files. Normally, this will also install numpy for better performance, if you don't have it installed already. However, numpy is optional. If you don't want to install numpy or if you can't compile it, you can edit setup.py and remove the install_requires=['numpy'], line before running python setup.py install.
Afterwards, websockify should be available in your path. Run
websockify --help to confirm it's installed correctly.
-------------------------------------------
SOCKS5 over WebSockets
SOCKS5 is a dead simple little protocol that makes very thin TCP and UDP proxies. SOCKS is notable because it allows the client to decide where to proxy to.
This code implements SOCKS5 on top of WebSockets. If you point websockify at a SOCKS proxy, you will be able to proxy from your web browser to anywhere in the world.
Demo
Run a SOCKS server. The quickest is:
$ ssh -D 7777 localhost
Run websockify in front of that SOCKS server
$ websockify 8081 localhost:7777
Run the socks5.js client:
$ node test.socks5.js google.com:80
You probably need to
npm install ws and npm install ayepromise first.
This gets more interesting if instead of sshing in the first step to localhost, you ssh somewhere you have a shell account. Then the demo script will appear to google (or whoever you hit) to be coming from the system you have a shell account on.
The same library also works in your browser!
API
The API is based heavily on Promises/A+, which allows writing async code in a nearly-synchronous way.
var prx = new SOCKS5("ws://my-socks-proxy:1080", "bbs-site.com:666")
prx.onopen = function() {
prx.send("Hello!")
prx.read(20).then(function(data) {
//...
}).then(function() { return prx.read(21) }) //It is important to wrap future reads in
// thunks so that reads are ordered properly.
.then(function(data) { //When the promise of prx.read() resolves,
// its value ends up in 'data'.
//...
})
}
SOCKS software
Servers:
- ssh has a
-Dswitch which makes your local machine into a SOCKS proxy, tunneling through to the other end of your ssh session. By default it only allows connections from localhost which is reasonably secure for short term use like getting around a school firewall. - dante is a little more fully featured SOCKS system with whitelisting and bandwidth throttling.
- tor relies crucially on SOCKS to move your traffic--including your DNS traffic--off your computer and into the TOR mixnet.
Clients:
- Most browsers support SOCKS5. Look under Network Settings in Firefox.
- tsocks which was forked to torsocks which wraps any Unix program through a SOCKS proxy.
frm https://github.com/kousu/socks5.ws
----
websockify client on python
----
websockify client on python
websockify-client
这东西能将 websockify 转成 websocket 的数据再转回 TCP
How to use
On server
On client
usage: websockify-client.py [-h] -r REMOTE_ADDRESS [-l BIND_ADDRESS]
[-p BIND_PORT]
optional arguments:
-h, --help show this help message and exit
-r REMOTE_ADDRESS, --remote-address REMOTE_ADDRESS
Remote address, like
"ws://your.site.example.org/some/path"
-l BIND_ADDRESS, --listen-address BIND_ADDRESS
Listen address, default value is "127.0.0.1"
-p BIND_PORT, --bind-port BIND_PORT
Bind port, default value is "3124"
Examples:
./websockify-client.py --remote-address ws://your.site.example.org/some/path
./websockify-client.py \
--remote-address ws://your.site.example.org/some/path \
--listen-address 127.0.0.1 \
--bind-port 10086frm https://github.com/MisakaMikoto-35c5/websockify-client
