ws-tool

an easy to use websocket tool.

features:

support tls & self signed cert
support setting http proxy & socks5 proxy
tested by autobahn

usage

basic usage

use ws_tool::{frame::Frame, ClientBuilder};
let mut client = ClientBuilder::new("wss://privaterookie.com").proxy("socks5://proxy:proxy_port").build().await.unwrap();
client.connect().await.unwrap();
client.read_frame().await.unwrap();

self signed cert

examples/echo show how to connect to a websocket with self signed cert.

to run this example, first running gen_cert example to get cert & key for testing

cargo run --example gen_cert -- wsl.com

-----BEGIN CERTIFICATE-----
MIIBSDCB76ADAgECAgEqMAoGCCqGSM49BAMCMCExHzAdBgNVBAMMFnJjZ2VuIHNl
bGYgc2lnbmVkIGNlcnQwIBcNNzUwMTAxMDAwMDAwWhgPNDA5NjAxMDEwMDAwMDBa
MCExHzAdBgNVBAMMFnJjZ2VuIHNlbGYgc2lnbmVkIGNlcnQwWTATBgcqhkjOPQIB
BggqhkjOPQMBBwNCAAQiCxhMtKyW0sJuBkwSF0nEQ0FYNhkBty08WKlq4wwNAwyb
KkkaRuhI9vFk5P36aPG34t3IDaJLy66xDiQ82szIoxYwFDASBgNVHREECzAJggd3
c2wuY29tMAoGCCqGSM49BAMCA0gAMEUCIFxJTfq0WH3i4MW9O4RNKRxacEArrv3o
HGGhdKaBYHxoAiEAy8WuKhwxNj4rjLT4wzItTTQmfjtajILO1h3qkTvJRrs=
-----END CERTIFICATE-----

-----BEGIN PRIVATE KEY-----
MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQg8z5eL3nUiyTTL+ll
Jb0YEJ523JthkaQpfF03W/ZhLyGhRANCAAQiCxhMtKyW0sJuBkwSF0nEQ0FYNhkB
ty08WKlq4wwNAwybKkkaRuhI9vFk5P36aPG34t3IDaJLy66xDiQ82szI
-----END PRIVATE KEY-----

save cert as target.pem and key as target-key.pem under scripts dir.

Then edit your /etc/hosts, add dns record for wsl.com domain, after that, run scripts/ssl_server.py to setup a websocket server.

python scripts/ssl_server.py
running on 0.0.0.0:4430

now you can connect websocket server with following command

cargo run --example echo -- wss://wsl.com:4430 -c ./scripts/target.pem

[SEND] > rookie
[RECV] > Hello rookie!
[SEND] > ^C

use proxy

examples/binance show how to connect via proxy

run autobaha testsuit

start test server

./script/start_autobahn_server.sh

run test on other terminal

cargo run --example autobahn-client

report files should be under test_reports dir.

autobahn test report

report

TODO

add proxy auth config
support custom https proxy cert
split client into writer & reader

ws-tool 0.3.0-alpha