Shadowsocks-libev is a lightweight secured SOCKS5 proxy for embedded devices and low-end boxes.

It is a port of Shadowsocks created by @clowwindy, which is maintained by @madeye and @linusyang.

Current version: 2.4.5 | Changelog

Travis CI: | Jenkins Matrix:

Shadowsocks-libev is written in pure C and only depends on libev and OpenSSL or PolarSSL. The use of mbedTLS is added but still for testing, and it is not officially supported yet.

In normal usage, the memory footprint is about 600KB and the CPU utilization is no more than 5% on a low-end router (Buffalo WHR-G300N V2 with a 400MHz MIPS CPU, 32MB memory and 4MB flash).

For a full list of feature comparison between different versions of shadowsocks, refer to the Wiki page.

• Debian & Ubuntu
  • Install from repository
  • Build deb package from source
  • Configure and start the service
• Fedora & RHEL
  • Install from repository
• OpenSUSE
  • Install from repository
  • Build from source
• Archlinux
• Directly build and install on UNIX-like system
• FreeBSD
• OpenWRT
• OS X
• Windows

For a complete list of avaliable configure-time option, try configure --help.

There are three crypto libraries available:

• OpenSSL (default)
• PolarSSL
• mbedTLS (NOT officially supported)

To build against PolarSSL, specify --with-crypto-library=polarssl and --with-polarssl=/path/to/polarssl when running ./configure.

• PolarSSL 1.2.5 or newer is required. Currently, PolarSSL does NOT support CAST5-CFB, DES-CFB, IDEA-CFB, RC2-CFB and SEED-CFB.
• RC4 is only support by PolarSSL 1.3.0 or above.

To build against mbedTLS, specify --with-crypto-library=mbedtls and --with-mbedtls=/path/to/mbedtls when running ./configure.

Please note that we do NOT officially support mbedTLS right now, and you should use it at your own risk.

Windows users will need extra work when compiling mbedTLS library, see this issue for detail info.

Please specify --enable-system-shared-lib. This will replace the bundled libev, libsodium and libudns with the corresponding libraries installed in the system during compilation and linking.

Note: The repository doesn't always contain the latest version. Please build from source if you want the latest version (see below)

Add GPG public key:

wget -O- http://shadowsocks.org/debian/1D27208A.gpg | sudo apt-key add -

Add either of the following lines to your /etc/apt/sources.list:

# Ubuntu 14.04 or above deb http://shadowsocks.org/ubuntu trusty main # Debian Wheezy, Ubuntu 12.04 or any distribution with libssl > 1.0.1 deb http://shadowsocks.org/debian wheezy main 

Then:

sudo apt-get update sudo apt-get install shadowsocks-libev

Supported Platforms:

• Debian 7 (see below), 8, unstable
• Ubuntu 14.04 (see below), Ubuntu 14.10, 15.04, 15.10 or higher

Note for Ubuntu 14.04 users: Packages built on Ubuntu 14.04 may be used in later Ubuntu versions. However, packages built on Debian 7/8/9 or Ubuntu 14.10+ cannot be installed on Ubuntu 14.04.

Note for Debian 7.x users: To build packages on Debian 7 (Wheezy), you need to enable debian-backports to install systemd-compatibility packages like dh-systemd or init-system-helpers. Please follow the instructions on Debian Backports.

This also means that you can only install those built packages on systems that have init-system-helpers installed.

Otherwise, try to build and install directly from source. See the Linux section below.

cd shadowsocks-libev sudo apt-get install build-essential autoconf libtool libssl-dev \ gawk debhelper dh-systemd init-system-helpers pkg-config dpkg-buildpackage -us -uc -i cd .. sudo dpkg -i shadowsocks-libev*.deb

# Edit the configuration file sudo vim /etc/shadowsocks-libev/config.json # Edit the default configuration for debian sudo vim /etc/default/shadowsocks-libev # Start the service sudo /etc/init.d/shadowsocks-libev start # for sysvinit, or sudo systemctl start shadowsocks-libev # for systemd 

Supported distributions include

• Fedora 20, 21, rawhide
• RHEL 6, 7 and derivatives (including CentOS, Scientific Linux)

Enable repo via dnf:

su -c 'dnf copr enable librehat/shadowsocks' 

Or download yum repo on Fedora Copr and put it inside /etc/yum.repos.d/. The release Epel is for RHEL and its derivatives.

Then, install shadowsocks-libev via dnf:

su -c 'dnf update' su -c 'dnf install shadowsocks-libev'

or yum:

su -c 'yum update' su -c 'yum install shadowsocks-libev'

Use the following command to install from repository.

sudo zypper install shadowsocks-libev

You should install zlib-devel and libopenssl-devel first.

sudo zypper update sudo zypper install zlib-devel libopenssl-devel

Then download the source package and compile.

git clone https://github.com/shadowsocks/shadowsocks-libev.git cd shadowsocks-libev ./configure && make sudo make install

sudo pacman -S shadowsocks-libev

Please refer to downstream PKGBUILD script for extra modifications and distribution-specific bugs.

For Unix-like systems, especially Debian-based systems, e.g. Ubuntu, Debian or Linux Mint, you can build the binary like this:

sudo apt-get install build-essential autoconf libtool libssl-dev ./configure && make sudo make install

su cd /usr/ports/net/shadowsocks-libev make install

Edit your config.json file. By default, it's located in /usr/local/etc/shadowsocks-libev.

To enable shadowsocks-libev, add the following rc variable to your /etc/rc.conf file:

shadowsocks_libev_enable="YES" 

Start the Shadowsocks server:

service shadowsocks_libev start

Note: You may want to use openwrt-shadowsocks , which is developed specifically for OpenWRT.

# At OpenWRT build rootpushd package git clone https://github.com/shadowsocks/shadowsocks-libev.git popd# Enable shadowsocks-libev in network category make menuconfig # Optional make -j # Build the package make V=99 package/shadowsocks-libev/openwrt/compile

For OS X, use Homebrew to install or build.

Install Homebrew:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install shadowsocks-libev:

brew install shadowsocks-libev

For Windows, use either MinGW (msys) or Cygwin to build. At the moment, only ss-local is supported to build against MinGW (msys).

If you are using MinGW (msys), please download OpenSSL or PolarSSL source tarball to the home directory of msys, and build it like this (may take a few minutes):

tar zxf openssl-1.0.1e.tar.gz cd openssl-1.0.1e ./config --prefix="$HOME/prebuilt" --openssldir="$HOME/prebuilt/openssl" make && make install

tar zxf polarssl-1.3.2-gpl.tgz cd polarssl-1.3.2 make lib WINDOWS=1 make install DESTDIR="$HOME/prebuilt"

Then, build the binary using the commands below, and all .exe files will be built at $HOME/ss/bin:

./configure --prefix="$HOME/ss" --with-openssl="$HOME/prebuilt" make && make install

./configure --prefix="$HOME/ss" --with-crypto-library=polarssl --with-polarssl=$HOME/prebuilt make && make install

For a detailed and complete list of all supported arguments, you may refer to the man pages of the applications, respectively.

 ss-[local|redir|server|tunnel] -s <server_host> host name or ip address of your remote server -p <server_port> port number of your remote server -l <local_port> port number of your local server -k <password> password of your remote server [-m <encrypt_method>] encrypt method: table, rc4, rc4-md5, aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, camellia-128-cfb, camellia-192-cfb, camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb, rc2-cfb, seed-cfb, salsa20 ,chacha20 and chacha20-ietf [-f <pid_file>] the file path to store pid [-t <timeout>] socket timeout in seconds [-c <config_file>] the path to config file [-i <interface>] network interface to bind, not available in redir mode [-b <local_address>] local address to bind, not available in server mode [-u] enable udprelay mode, TPROXY is required in redir mode [-U] enable UDP relay and disable TCP relay, not available in local mode [-A] enable onetime authentication [-L <addr>:<port>] specify destination server address and port for local port forwarding, only available in tunnel mode [-d <addr>] setup name servers for internal DNS resolver, only available in server mode [--fast-open] enable TCP fast open, only available in local and server mode, with Linux kernel > 3.7.0 [--acl <acl_file>] config file of ACL (Access Control List) only available in local and server mode [--manager-address <addr>] UNIX domain socket address only available in server and manager mode [--executable <path>] path to the executable of ss-server only available in manager mode [-v] verbose mode notes: ss-redir provides a transparent proxy function and only works on the Linux platform with iptables. 

The latest shadowsocks-libev has provided a redir mode. You can configure your Linux-based box or router to proxy all TCP traffic transparently.

# Create new chain root@Wrt:~# iptables -t nat -N SHADOWSOCKS root@Wrt:~# iptables -t mangle -N SHADOWSOCKS # Ignore your shadowsocks server's addresses # It's very IMPORTANT, just be careful. root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 123.123.123.123 -j RETURN # Ignore LANs and any other addresses you'd like to bypass the proxy # See Wikipedia and RFC5735 for full list of reserved networks. # See ashi009/bestroutetb for a highly optimized CHN route list. root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 0.0.0.0/8 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 10.0.0.0/8 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 127.0.0.0/8 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 169.254.0.0/16 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 172.16.0.0/12 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 192.168.0.0/16 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 224.0.0.0/4 -j RETURN root@Wrt:~# iptables -t nat -A SHADOWSOCKS -d 240.0.0.0/4 -j RETURN # Anything else should be redirected to shadowsocks's local port root@Wrt:~# iptables -t nat -A SHADOWSOCKS -p tcp -j REDIRECT --to-ports 12345 # Add any UDP rules root@Wrt:~# ip rule add fwmark 0x01/0x01 table 100 root@Wrt:~# ip route add local 0.0.0.0/0 dev lo table 100 root@Wrt:~# iptables -t mangle -A SHADOWSOCKS -p udp --dport 53 -j TPROXY --on-port 12345 --tproxy-mark 0x01/0x01 # Apply the rules root@Wrt:~# iptables -t nat -A PREROUTING -p tcp -j SHADOWSOCKS root@Wrt:~# iptables -t mangle -A PREROUTING -j SHADOWSOCKS # Start the shadowsocks-redir root@Wrt:~# ss-redir -u -c /etc/config/shadowsocks.json -f /var/run/shadowsocks.pid 

Although shadowsocks-libev can handle thousands of concurrent connections nicely, we still recommend setting up your server's firewall rules to limit connections from each user:

# Up to 32 connections are enough for normal usage iptables -A INPUT -p tcp --syn --dport ${SHADOWSOCKS_PORT} -m connlimit --connlimit-above 32 -j REJECT --reject-with tcp-reset 

Copyright (C) 2015 Max Lv max.c.lv@gmail.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.