penguin-rs

Rusty Penguin

Logo

Rust Build and Test Crates.io Dependency Status Codecov License

About

A fast TCP/UDP tunnel, transported over HTTP WebSocket. You are right. This project is inspired by jpillora/chisel (and subsequently my fork myzhang1029/penguin), but completely rewritten in Rust without any linkage to chisel. The logo is generated by DALL-E with the prompt “a penguin standing behind a gear wheel, digital art, logo.”

Basic Usage

Server

$ penguin server --host ::1 --port 443 --tls-cert cert.pem --tls-key key.pem --ws-psk some-secret

See penguin server --help for more options.

Client

$ penguin client --ws-psk some-secret wss://server 1080:socks 80:example.com:80

See penguin client --help for more options.

Comparison

Compared to the original penguin or chisel, this project stripped away some functionalities:

Other than that, this project offers these functionalities compared to chisel:

$ iperf3 -c 127.0.0.1 # penguin without TLS [ ID] Interval Transfer Bitrate [ 5] 0.00-10.00 sec 14.2 GBytes 12.2 Gbits/sec sender [ 5] 0.00-10.00 sec 14.2 GBytes 12.2 Gbits/sec receiver

$ iperf3 -c 127.0.0.1 # chisel with TLS [ ID] Interval Transfer Bitrate [ 5] 0.00-10.00 sec 5.59 GBytes 4.80 Gbits/sec sender [ 5] 0.00-10.00 sec 5.58 GBytes 4.80 Gbits/sec receiver

$ iperf3 -c 127.0.0.1 # penguin with TLS [ ID] Interval Transfer Bitrate [ 5] 0.00-10.00 sec 8.96 GBytes 7.70 Gbits/sec sender [ 5] 0.00-10.00 sec 8.95 GBytes 7.69 Gbits/sec receiver ```

Protocol

Servers and clients with the same protocol version are compatible with each other. However, for the best performance, it is recommended to use the same version of penguin on both sides.

The current protocol version is penguin-v6. See PROTOCOL.md for details.

License

GPL v3.0 or later or Apache License 2.0.