shadowsocks

This is a port of shadowsocks.

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

Build & Install

Optional Features

• trust-dns - Uses trust-dns-resolver as DNS resolver instead of tokio's builtin.

• local-http - Allow using HTTP protocol for sslocal

  • local-http-native-tls - Support HTTPS with native-tls

  • local-http-rustls - Support HTTPS with rustls

• local-tunnel - Allow using tunnel protocol for sslocal

• local-socks4 - Allow using SOCKS4/4a protocol for sslocal

• local-redir - Allow using redir (transparent proxy) protocol for sslocal

Memory Allocators

This project uses system (libc) memory allocator (Rust's default). But it also allows you to use other famous allocators by features:

• jemalloc - Uses jemalloc as global memory allocator
• mimalloc - Uses mi-malloc as global memory allocator
• tcmalloc - Uses TCMalloc as global memory allocator. It tries to link system-wide tcmalloc by default, use vendored from source with tcmalloc-vendored.

Default features: ["trust-dns", "local-http", "local-http-native-tls", "local-tunnel", "local-socks4"].

crates.io

Install from crates.io:

cargo install shadowsocks-rust

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

Download release

Requirements:

• Linux x86_64
• Windows x86_64

Download static-linked build here.

Nightly builds could be downloaded from CircleCI. HOW TO

• build-windows: Build for x86_64-pc-windows-msvc
• build-linux: Build for x86_64-unknown-linux-gnu, Debian 9 (Stretch), GLIBC 2.18
• build-docker: Build for x86_64-unknown-linux-musl, x86_64-pc-windows-gnu, ... (statically linked)

Build from source

Use cargo to build.

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.

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.

target-cpu optimization

If you are building for your current CPU platform (for example, build and run on your personal computer), it is recommended to set target-cpu=native feature to let rustc generate and optimize code for the CPU running the compiler.

export RUSTFLAGS="-C target-cpu=native"

Build standalone binaries

Requirements:

• Docker

./build/build-release

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

• ./build/shadowsocks-${VERSION}-stable.x86_64-unknown-linux-musl.tar.xz
• ./build/shadowsocks-${VERSION}-stable.x86_64-pc-windows-gnu.zip

Read Cargo.toml for more details.

Getting Started

Create a ShadowSocks' configuration file. Example

{
    "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:

{
    "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:

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

If you Build it with Cargo:

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

List all available arguments with -h.

Usage

Socks5 Local client

# 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://[email protected]:8388/?plugin=obfs-local%3Bobfs%3Dtls"

HTTP Local client

# 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

# 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

• Linux (with iptables targets REDIRECT and TPROXY)
• BSDs (with pf), such as OS X 10.10+, FreeBSD, ...

# 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

# 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:

• add - Starts a server instance
• remove - Deletes an existing server instance
• list - Lists all current running servers
• ping - Lists all servers' statistic data

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

# 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:

{
    // Required option
    // Address that ssmanager is listening on
    "manager_address": "127.0.0.1",
    "manager_port": 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

{
    // LOCAL: Listen address
    // SERVER: Bind address for remote sockets, mostly used for choosing interface
    "local_address": "127.0.0.1",
    "local_port": 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

• table
• aes-128-cfb, aes-128-cfb1, aes-128-cfb8, aes-128-cfb128
• aes-192-cfb, aes-192-cfb1, aes-192-cfb8, aes-192-cfb128
• aes-256-cfb, aes-256-cfb1, aes-256-cfb8, aes-256-cfb128
• aes-128-ctr
• aes-192-ctr
• aes-256-ctr
• camellia-128-cfb, camellia-128-cfb1, camellia-128-cfb8, camellia-128-cfb128
• camellia-192-cfb, camellia-192-cfb1, camellia-192-cfb8, camellia-192-cfb128
• camellia-256-cfb, camellia-256-cfb1, camellia-256-cfb8, camellia-256-cfb128
• rc4-md5
• chacha20-ietf
• plain (No encryption, just for debugging)

AEAD Ciphers

• aes-128-gcm, aes-256-gcm
• chacha20-ietf-poly1305

ACL

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

Available sections

• For local servers (sslocal, ssredir, ...)
  • Modes:
    • [bypass_all] - ACL runs in BlackList mode. Bypasses all addresses that didn't match any rules.
    • [proxy_all] - ACL runs in WhiteList mode. Proxies all addresses that didn't match any rules.
  • Rules:
    • [bypass_list] - Rules for connecting directly
    • [proxy_list] - Rules for connecting through proxies
• For remote servers (ssserver)
  • Modes:
    • [reject_all] - ACL runs in BlackList mode. Rejects all clients that didn't match any rules.
    • [accept_all] - ACL runs in WhiteList mode. Accepts all clients that didn't match any rules.
  • Rules:
    • [white_list] - Rules for accepted clients
    • [black_list] - Rules for rejected clients
    • [outbound_block_list] - Rules for blocking outbound addresses.

Example

# 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
[outbound_block_list]
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:

ss://[email protected]:8388/?plugin=obfs-local%3Bobfs%3Dhttp%3Bobfs-host%3Dwww.baidu.com

Notes

It supports the following features:

• SOCKS5 CONNECT command
• SOCKS5 UDP ASSOCIATE command (partial)
• SOCKS4/4a CONNECT command
• Various crypto algorithms
• Load balancing (multiple servers) and server delay checking
• SIP004 AEAD ciphers
• SIP003 Plugins
• SIP002 Extension ss URLs
• HTTP Proxy Supports (RFC 7230 and CONNECT)
• Defend against replay attacks, shadowsocks/shadowsocks-org#44
• Manager APIs, supporting Manage Multiple Users
• ACL (Access Control List)
• Support HTTP/HTTPS Proxy protocol

TODO

• Documentation
• Extend configuration format
• Improved logging format (waiting for the new official log crate)
• Support more ciphers without depending on libcrypto (waiting for an acceptable Rust crypto lib implementation)
• Windows support.
• Build with stable rustc.
• Support HTTP Proxy protocol
• One-time Auth. (Already deprecated according to Shadowsocks' community)
• AEAD ciphers. (proposed in SIP004, still under discussion)
• Choose server based on delay #152
• Support TCP Fast Open

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.