Shadowsocks-ex

shadowsocks-ex is a elixir port of shadowsocks

A fast tunnel proxy that helps you bypass firewalls.

Features:

TCP support
UDP support (only server)
Client support
Server support
OTA support
Mulit user support
Transparent Proxy Client support

Encryption methods

rc4-md5
aes-128-cfb
aes-192-cfb
aes-256-cfb
aes-128-ctr
aes-192-ctr
aes-256-ctr

Installation

The package can be installed by adding shadowsocks to your list of dependencies in mix.exs:

def deps do
  [{:shadowsocks, "~> 0.2.3"}]
end

Documentation

The online docs can be found at https://hexdocs.pm/shadowsocks.

Usage

start a listener

Shadowsocks.start(args)

the args is a keyword list, fields:

type required atom - the connection type, :client or :server or custom module name

There are currently four built-in type:
1. Shadowsocks.Conn.Client - general client, alias is :client
2. Shadowsocks.Conn.Server - general server, alias is :server
3. Shadowsocks.Conn.TransparentClient - transparent client, perfect with iptables
4. Shadowsocks.Conn.HTTP302 - redirect any http get request to :redirect_url, otherwise drop connections
port required integer - listen port
ip optional tuple - listen ip, example: {127,0,0,1}
method optional string - encode method, default: "rc4-md5"
password required string - encode password
ota optional bool - is force open one time auth, default: false
server optional tuple - required if type is :client, example: {"la.ss.org", 8388}
udp optional bool - enable udp relay (experimental only support server side)

stop a listener

Shadowsocks.stop(port)

stop listener by listen port, always return :ok

update listener args

Shadowsocks.update(port, args)

the args is a keyword list, see Shadowsocks.start/1 method

Configuration

startup listeners example:

config :shadowsocks, :listeners,
  [
    [
      type: :server,
      method: "aes-192-cfb",
      password: "pass",
      port: 8888,
      ota: true,
      ip: {127, 0, 0, 1}
    ],
    [
      type: Shadowsocks.Conn.Http302,
      method: "rc4-md5",
      password: "pass",
      port: 8889,
      ota: false,
      ip: {0, 0, 0, 0},
      redirect_url: "http://ionet.cc"
    ],
    [
      type: :client,
      method: "aes-192-cfb",
      password: "pass",
      server: {"localhost", 8888},
      port: 1080,
      ota: true,
      ip: {127, 0, 0, 1}
    ],
  ]

compile time configs

config :shadowsocks, :report,
    port_min_flow: 5 * 1024 * 1024, # report flow when cached flow exceed :port_min_flow
    port_min_time: 60 * 1000,       # report flow when cached flow after :port_min_time
    conn_min_flow: 5 * 1024 * 1024  # send flow to listener when cached flow exceed :conn_min_flow

Connection Events

Event name: Shadowsocks.Event

events:

{:port, :open, port}                       # when start listener on port
{:conn, :open, {port, pid, {addr, port}}}  # when received connection request
{:conn, :close, {port, pid, reason, flow}} # when connection process exited
{:conn, :connect, {port, pid, {ret, addr, port}}} # connect to remote addr result
{:port, :flow, {port, down, up}}           # flow report on the port

milkwine/shadowsocks-ex