shadowsocks-rust

Codacy Badge Build Status License crates.io dependency status Release

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"].

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

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.

Build from source

Use cargo to build.

bash cargo build --release

NOTE: If you haven't installed the correct version of libsodium in your system, you can set a environment variable SODIUM_BUILD_STATIC=yes to let libsodium-ffi to build libsodium from source, which requires you to have build tools (including GCC, libtools, etc.) installed.

bash SODIUM_BUILD_STATIC=yes 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 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 and ssurl will be packaged in

Read Cargo.toml for more details.

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-cfb" }

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": "bf-cfb", "timeout": 300 }, { "address": "127.0.0.1", "port": 1081, "password": "hello-kitty", "method": "aes-128-cfb" } ], "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

sstunnel -c /path/to/shadowsocks.json -f "127.0.0.1:8080" ```

sstunnel basically works the same as sslocal, only it doesn't have any client negociation process, just establishes a tunnel to the forward address.

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" ```

Supported Ciphers

Stream Ciphers

AEAD Ciphers

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.