本文前篇为英文文档介绍，身为技术出身，我还是更喜欢阅读英文文档，介绍的透彻直击重点，也不是说中文的文档就不好了，各有喜好吧。以下均亲测可用。
Intro
Shadowsocks-libev is a lightweight secured scoks5 proxy for embedded devices and low end boxes.
It is a port of shadowsocks created by @clowwindy maintained by @madeye and @linusyang.
Current version: 1.4.8 | 
| Changelog
Features
Shadowsocks-libev is writen in pure C and only depends on libev and openssl or polarssl.
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).
Installation
Notes about PolarSSL
- Default crypto library is OpenSSL. To build against PolarSSL, specify
--with-crypto-library=polarssland--with-polarssl=/path/to/polarsslwhen 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.
Debian & Ubuntu
Install from repository
Add either of the following lines to your /etc/apt/sources.list
# Debian Wheezy, Ubuntu 12.04 or any distribution with libssl > 1.0.1
deb http://shadowsocks.org/debian wheezy main
# Debian Squeeze, Ubuntu 11.04, or any distribution with libssl > 0.9.8, but < 1.0.0
deb http://shadowsocks.org/debian squeeze main
Then,
sudo apt-get update sudo apt-get install shadowsocks
Build package from source
cd shadowsocks-libev sudo apt-get install build-essential autoconf libtool libssl-dev gawk debhelper sudo dpkg-buildpackage cd … sudo dpkg -i shadowsocks*.deb
Configure and start the service
# Edit the configuration
sudo vim /etc/shadowsocks/config.json
# Start the service
sudo /etc/init.d/shadowsocks start
CentOS
Install the dependencies,
yum install -y gcc automake autoconf libtool make build-essential autoconf libtool yum install -y curl curl-devel zlib-devel openssl-devel perl perl-devel cpio expat-devel gettext-devel
Compile and install,
./configure && make make install
Then copy this init script to /etc/init.d/ .
Linux
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
FreeBSD
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
OpenWRT
At OpenWRT build root pushd package git clone https://github.com/madeye/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
Windows
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):
- OpenSSL
tar zxf openssl-1.0.1e.tar.gz cd openssl-1.0.1e ./config --prefix="$HOME/prebuilt" --openssldir="$HOME/prebuilt/openssl" make && make install
- PolarSSL
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 :
- OpenSSL
./configure --prefix="$HOME/ss" --with-openssl="$HOME/prebuilt" make && make install
- PolarSSL
./configure --prefix="$HOME/ss" --with-crypto-library=polarssl --with-polarssl=$HOME/prebuilt make && make install
Usage
usage:
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 and seed-cfb
[-f <pid_file>] file to store the pid
[-t <timeout>] socket timeout in seconds
[-c <config_file>] config file in json
[-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
not available in redir mode
[-L <addr>:<port>] setup a local port forwarding tunnel,
only available in tunnel mode
[-v] verbose mode
[--fast-open] enable TCP fast open,
only available on Linux kernel > 3.7.0
[--acl <acl_file>] config file of ACL (Access Control List)
notes:
ss-redir provides a transparent proxy function and only works on the
Linux platform with iptables.
Advanced usage
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
# 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
# Apply the rules
root@Wrt:~# iptables -t nat -A OUTPUT -p tcp -j SHADOWSOCKS
# Start the shadowsocks-redir
root@Wrt:~# ss-redir -c /etc/config/shadowsocks.json -f /var/run/shadowsocks.pid
Security Tips
Although shadowsocks-libev can handle thousands of concurrent connections nicely, we still recommend to set up your server’s firewall rules to limit connections from each user.
# Up to 32 connections are enough for normal usages
iptables -A INPUT -p tcp --syn --dport ${SHADOWSOCKS_PORT} -m connlimit --connlimit-above 32 -j REJECT --reject-with tcp-reset
License
Copyright (C) 2014 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 Licenses - GNU Project - Free Software Foundation.
一般的ShadowSocks实现套装都包含有ShadowSocks Server（Socks Server的实现）和ShadowSocks Client（Socks Client的实现）（跟SSH的实现套装OpenSSH包含有SSH Server的实现和SSH Client的实现一样），常见的ShadowSocks实现套装有：shadowsocks-python,shadowsocks-go,shadowsocks-libev,shadowsocks-libqss（分别由Python语言，Go语言，C语言，C++语言实现）等。
备注：
另外也存在着单独的ShadowSocks Server和ShadowSocks Client，比如Shadowsocks-Qt5就是单独的ShadowSocks Client。
我们以"shadowsocks-libev"为例，进行安装说明。
1、安装基本原理
首先将"shadowsocks-libev"的源码下载到本地（shadowsocks-libev的github地址为：https://github.com/shadowsocks/shadowsocks-libev.git，为了能从github下载源码，需要已经安装好"git"）
然后使用从源码编译安装“3步曲”进行安装（需要已经安装好"build-essential autoconf libtool libssl-dev gawk"）
2、安装脚本
有一个Shell脚本文件，名称为"InstallShadowSocks.sh"，它的内容如下：
[plain] view plain copy
- #!/bin/bash
- #安装"git build-essential autoconf libtool libssl-dev gawk"
- apt-get update
- apt-get install git build-essential autoconf libtool libssl-dev gawk
- git clone https://github.com/shadowsocks/shadowsocks-libev.git
- #使用安装“3步曲”进行安装
- cd shadowsocks-libev
- ./configure && make
- make install
由于该脚本中的"apt-get install"命令需要一个"yes|no"的回答，因而具体执行以上脚本的命令如下：
[plain] view plain copy
- echo “YES” | ./InstallShadowSocks.sh
在安装好"shadowsocks-libev"之后，接下来介绍如何在服务器上运行ShadowSocks Server和在本地机器上运行ShadowSocks Client。
一、运行ShadowSocks Server
执行"ss-server"命令，就可以运行ShadowSocks Server。运行ShadowSocks Server需要加载配置有基本选项值的配置文件，配置文件的格式支持JSON。
1.1、JSON配置文件
建立一个ShadowSocks Server运行时需要的配置文件，格式为JSON，路径为任意路径。
具体内容如下：
[plain] view plain copy
- {
- “server”:“example.com or X.X.X.X”,
- “server_port”:443,
- “password”:“password”,
- “method”:“aes-256-cfb”,
- “timeout”:60
- }
其中：
[plain] view plain copy
- server：ShadowSocks Server所在机器的域名或者IP地址，尽量填IP
- server_port：ShadowSocks Server监听的端口
- password：ShadowSocks Server配置的密码
- 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"
- timeout：连接断开时间
1.2、运行
通过"ss-server"命令的帮助信息（执行"ss-server -?“命令可得），可知”-c"选项可以指定需要加载的配置文件的路径，因而我们可以通过该选项加载"1.1、JSON配置文件"中的JSON配置文件。
并且为了让ShadowSocks Server在后台持续运行，我们可以得到最终的运行ShadowSocks Server的命令如下：
[plain] view plain copy
- nohup ss-server -c JSON配置文件路径 > log.out &
二、运行ShadowSocks Client
执行"ss-local"命令，就可以运行ShadowSocks Client。运行ShadowSocks Client需要加载配置有基本选项值的配置文件，配置文件的格式支持JSON。
2.1、JSON配置文件
建立一个ShadowSocks Client运行时需要的配置文件，格式为JSON，路径为任意路径。
具体内容如下：
[plain] view plain copy
- {
- “server”:“example.com or X.X.X.X”,
- “server_port”:443,
- “local_port”:1080,
- “password”:“password”,
- “method”:“aes-256-cfb”
- }
其中：
[plain] view plain copy
- server：ShadowSocks Server所在机器的域名或者IP地址，尽量填IP
- server_port：ShadowSocks Server监听的端口
- local_port：本地监听端口
- password：ShadowSocks Server配置的密码
- 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"
2.2、运行
通过"ss-local"命令的帮助信息（执行"ss-local -?“命令可得），可知”-c"选项可以指定需要加载的配置文件的路径，因而我们可以通过该选项加载"2.1、JSON配置文件"中的JSON配置文件。
并且为了让ShadowSocks Client在后台持续运行，我们可以得到最终的运行ShadowSocks Client的命令如下：
[plain] view plain copy
- nohup ss-local -c JSON配置文件路径 > log.out &