shadowsocks-rust

Build Status Build status License crates.io Release CircleCI

This is a port of shadowsocks.

shadowsocks is a fast tunnel proxy that helps you bypass firewalls.

Dependencies

Build & Install

Optional Features

Default features: ["sodium", "rc4", "aes-cfb", "aes-ctr", "trust-dns", "local-http", "local-http-native-tls", "local-tunnel", "local-socks4"].

NOTE: To disable dependency of OpenSSL, just disable feature rc4, aes-cfb, aes-ctr, camellia-cfb, local-http-native-tls.

crates.io

Install from crates.io:

bash cargo install shadowsocks-rust

then you can find sslocal and ssserver in $CARGO_HOME/bin.

Download release

Requirements:

Download static-linked build here.

Nightly builds could be downloaded from CircleCI. HOW TO

Build from source

Use cargo to build.

bash cargo build --release

NOTE: libsodium-sys builds and links statically to the libsodium in its package. Here are some useful environment variables for customizing build processes:

bash SODIUM_USE_PKG_CONFIG=1 cargo build --release

Then sslocal and ssserver will appear in ./target/(debug|release)/, it works similarly as the two binaries in the official ShadowSocks' implementation.

bash make install TARGET=release

Then sslocal, ssserver, sstunnel and ssurl will be installed in /usr/local/bin (variable PREFIX).

For Windows users, if you have encountered any problem in building, check and discuss in #102.

Build standalone binaries

Requirements:

bash ./build/build-release

Then sslocal, ssserver, sstunnel and ssurl will be packaged in

Read Cargo.toml for more details.

Build OpenSSL from source

Specify feature openssl-vendored to let openssl build from source.

bash cargo build --features "openssl-vendored"

Getting Started

Create a ShadowSocks' configuration file. Example

json { "server": "my_server_ip", "server_port": 8388, "local_address": "127.0.0.1", "local_port": 1080, "password": "mypassword", "timeout": 300, "method": "aes-256-gcm" }

Detailed explanation could be found in shadowsocks' documentation.

In shadowsocks-rust, we also have an extended configuration file format, which is able to define more than one servers:

json { "servers": [ { "address": "127.0.0.1", "port": 1080, "password": "hello-world", "method": "aes-256-gcm", "timeout": 300 }, { "address": "127.0.0.1", "port": 1081, "password": "hello-kitty", "method": "chacha20-ietf-poly1305" } ], "local_port": 8388, "local_address": "127.0.0.1" }

The sslocal will use a load balancing algorithm to dispatch packages to all servers.

Start local and server ShadowSocks with If you Build it with Makefile:

bash sslocal -c config.json ssserver -c config.json

If you Build it with Cargo:

bash cargo run --bin sslocal -- -c config.json cargo run --bin ssserver -- -c config.json

List all available arguments with -h.

Usage

Socks5 Local client

```bash

Read local client configuration from file

sslocal -c /path/to/shadowsocks.json

Pass all parameters via command line

sslocal -b "127.0.0.1:1080" -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --plugin "obfs-local" --plugin-opts "obfs=tls"

Pass server with SIP002 URL

sslocal -b "127.0.0.1:1080" --server-url "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ@127.0.0.1:8388/?plugin=obfs-local%3Bobfs%3Dtls" ```

HTTP Local client

```bash

Read local client configuration from file

sslocal -c /path/to/shadowsocks.json --protocol http ```

All parameters are the same as Socks5 client, except --protocol http.

Tunnel Local client

```bash

Read local client configuration from file

Set 127.0.0.1:8080 as the target for forwarding to

sslocal -c /path/to/shadowsocks.json -f "127.0.0.1:8080" --protocol tunnel ```

Transparent Proxy Local client

NOTE: This is currently only supports

```bash

Read local client configuration from file

sslocal -c /path/to/shadowsocks.json --protocol redir ```

Redirects connections with iptables configurations to the port that sslocal is listening on.

Server

```bash

Read server configuration from file

ssserver -c /path/to/shadowsocks.json

Pass all parameters via command line

ssserver -s "[::]:8388" -m "aes-256-gcm" -k "hello-kitty" --plugin "obfs-server" --plugin-opts "obfs=tls" ```

Server Manager

Supported Manage Multiple Users API:

NOTE: stat command is not supported. Because servers are running in the same process with the manager itself.

```bash

Start it just with --manager-address command line parameter

ssmanager --manager-address "127.0.0.1:6100"

For *nix system, manager can bind to unix socket address

ssmanager --manager-address "/tmp/shadowsocks-manager.sock"

You can also provide a configuration file

#

manager_address key must be provided in the configuration file

ssmanager -c /path/to/shadowsocks.json

Create one server by UDP

echo 'add: {"server_port":8388,"password":"hello-kitty"}' | nc -u '127.0.0.1' '6100'

Close one server by unix socket

echo 'remove: {"server_port":8388}' | nc -Uu '/tmp/shadowsocks-manager.sock' ```

For manager UI, check more details in the shadowsocks-manager project.

Example configuration:

```jsonc { // Required option // Address that ssmanager is listening on "manageraddress": "127.0.0.1", "managerport": 6100,

// Or bind to a Unix Domain Socket
"manager_address": "/tmp/shadowsocks-manager.sock",

"servers": [
    // These servers will be started automatically when ssmanager is started
],

// Outbound socket binds to this IP address
// For choosing different network interface on the same machine
"local_address": "xxx.xxx.xxx.xxx",

// Other options that may be passed directly to new servers

} ```

Configuration

```jsonc { // LOCAL: Listen address // SERVER: Bind address for remote sockets, mostly used for choosing interface "localaddress": "127.0.0.1", "localport": 1080,

// Server's configuration
"server": "0.0.0.0",
"server_port": 8388,
"method": "aes-256-gcm",
"password": "your-password",
"plugin": "v2ray-plugin",
"plugin_opts": "mode=quic;host=www.shadowsocks.com",
"timeout": 5, // Timeout for TCP relay server (in seconds)

// Extended multiple server configuration
// LOCAL: Choosing the best server to connect dynamically
// SERVER: Creating multiple servers in one process
"servers": [
    {
        // Fields are the same as the single server's configuration
        "address": "0.0.0.0",
        "port": 8389,
        "method": "aes-256-gcm",
        "password": "your-password",
        "plugin": "...",
        "plugin_opts": "...",
        "timeout": 5,
    }
],

// Global configurations for UDP associations
"udp_timeout": 5, // Timeout for UDP associations (in seconds), 5 minutes by default
"udp_max_associations": 512, // Maximum UDP associations to be kept in one server, unlimited by default

// Options for Manager
"manager_address": "127.0.0.1", // Could be a path to UNIX socket, /tmp/shadowsocks-manager.sock
"manager_port": 5300, // Not needed for UNIX socket

// DNS server's address for resolving domain names
// For *NIX and Windows, it uses system's configuration by default
//
// Value could be IP address of DNS server, for example, "8.8.8.8".
// DNS client will automatically request port 53 with both TCP and UDP protocol.
//
// It also allows some pre-defined well-known public DNS servers:
// - google (TCP, UDP)
// - cloudflare (TCP, UDP)
// - cloudflare_tls (TLS), enable by feature "dns-over-tls"
// - cloudflare_https (HTTPS), enable by feature "dns-over-https"
// - quad9 (TCP, UDP)
// - quad9_tls (TLS), enable by feature "dns-over-tls"
//
// The field is only effective if feature "trust-dns" is enabled.
"dns": "google",

// Mode, could be one of the
// - tcp_only
// - tcp_and_udp
// - udp_only
"mode": "tcp_only",

// TCP_NODELAY
"no_delay": false,

// Soft and Hard limit of file descriptors on *NIX systems
"nofile": 10240,

// Try to resolve domain name to IPv6 (AAAA) addresses first
"ipv6_first": false

} ```

Supported Ciphers

Stream Ciphers

AEAD Ciphers

ACL

sslocal, ssserver, and ssmanager support ACL file with syntax like shadowsocks-libev. Some examples could be found in here.

Available sections

Example

```ini

SERVERS

For ssserver, accepts requests from all clients by default

[accept_all]

Blocks these clients

[black_list] 1.2.3.4 127.0.0.1/8

Disallow these outbound addresses

[outboundblocklist] 127.0.0.1/8 ::1 (^|.)baidu.com

CLIENTS

For sslocal, ..., bypasses all targets by default

[bypass_all]

Proxy these addresses

[proxy_list] (^|.)google.com 8.8.8.8 ```

Useful Tools

  1. ssurl is for encoding and decoding ShadowSocks URLs (SIP002). Example:

    plain ss://YWVzLTI1Ni1jZmI6cGFzc3dvcmQ@127.0.0.1:8388/?plugin=obfs-local%3Bobfs%3Dhttp%3Bobfs-host%3Dwww.baidu.com

Notes

It supports the following features:

TODO

License

The MIT License (MIT)

Copyright (c) 2014 Y. T. CHUNG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.