Crate shadowsocks_service[][src]

Expand description

Shadowsocks Service

https://shadowsocks.org/

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

Usage

Build shadowsocks and you will get at least 2 binaries: sslocal and ssserver

Write your servers in a configuration file. Format is defined in shadowsocks’ documentation

For example:

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

Save it in file shadowsocks.json and run local proxy server with

cargo run --bin sslocal -- -c shadowsocks.json

Now you can use SOCKS5 protocol to proxy your requests, for example:

curl --socks5-hostname 127.0.0.1:1080 https://www.google.com

On the server side, you can run the server with

cargo run --bin ssserver -- -c shadowsocks.json

Server should use the same configuration file as local, except the listen addresses for servers must be socket addresses.

Of course, you can also use cargo install to install binaries.

Re-exports

pub use self::local::run as run_local;
pub use self::manager::run as run_manager;
pub use self::server::run as run_server;
pub use shadowsocks;

Modules

acl

Access Control List (ACL) for shadowsocks

config

This is a mod for storing and parsing configuration

local

Shadowsocks Local Server

manager

Shadowsocks manager service

net

Shadowsocks Sevice Network Utilities

server

Shadowsocks server