README.md

ss-rs

Shadowsocks client implements in Rust.

Usage

ss-rs is using toml as configuration file:

ss-rs -c config.toml

The templates of config file can be found in: example_config.toml.

Multiple servers is supported and will be pick according to network quality. see Server Pick

# Local bind address
bind_addr = "localhost:1080"

# Server 1 settings
[[server]]
password = "your_server_pass"
server_addr = "example.com:2000"
encrypt_method = "chacha20-ietf-poly1305"

# Server 2 settings
[[server]]
password = "your_server_pass"
server_addr = "example.com:2001"
encrypt_method = "aes-256-cfb"

Build

build with cargo

cargo build --release

Windows platform

OpenSSL is required(download), and following environment variables must be set:

• OPENSSL_DIR
• SSL_CERT_FILE

See appveyor.yml for more information.

Supported Ciphers

AEAD Ciphers

• chacha20-ietf-poly1305 Provide by ring

Stream Ciphers

• aes-256-cfb Provide by rust-openssl

Debug

Run with following environment variables:

RUST_BACKTRACE=1 RUST_LOG=ss_rs=trace ./ss-rs -c config.toml

About server pick

ss-rs will do handshake to all servers and select one which is first reply.

LICENSE

This project is licensed under the MIT license.