Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shadowsocksr-backup/shadowsocksr-libev

libev port of ShadowsocksR
https://github.com/shadowsocksr-backup/shadowsocksr-libev

Last synced: 4 days ago
JSON representation

libev port of ShadowsocksR

Awesome Lists containing this project

README 

        
# shadowsocks-libev



## Intro



[Shadowsocks-libev](http://shadowsocks.org) is a lightweight secured SOCKS5

proxy for embedded devices and low-end boxes.



It is a port of [Shadowsocks](https://github.com/shadowsocks/shadowsocks)

created by [@clowwindy](https://github.com/clowwindy), which is maintained by

[@madeye](https://github.com/madeye) and [@linusyang](https://github.com/linusyang).



Current version: 2.5.6 | [Changelog](debian/changelog)



Travis CI: [![Travis CI](https://travis-ci.org/shadowsocks/shadowsocks-libev.svg?branch=master)](https://travis-ci.org/shadowsocks/shadowsocks-libev)



## Features



Shadowsocks-libev is written in pure C and only depends on

[libev](http://software.schmorp.de/pkg/libev.html) and

[OpenSSL](http://www.openssl.org/) or [mbedTLS](https://tls.mbed.org/) or [PolarSSL](https://polarssl.org/).



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](https://github.com/shadowsocks/shadowsocks/wiki/Feature-Comparison-across-Different-Versions).



## Installation



### Distribution-specific guide



- [Debian & Ubuntu](#debian--ubuntu)

    + [Install from repository](#install-from-repository)

    + [Build deb package from source](#build-deb-package-from-source)

    + [Configure and start the service](#configure-and-start-the-service)

- [Fedora & RHEL](#fedora--rhel)

    + [Install from repository](#install-from-repository-1)

- [OpenSUSE](#opensuse)

    + [Install from repository](#install-from-repository-2)

    + [Build from source](#build-from-source)

- [Archlinux](#archlinux)

- [NixOS](#nixos)

- [Nix](#nix)

- [Directly build and install on UNIX-like system](#linux)

- [FreeBSD](#freebsd)

- [OpenWRT](#openwrt)

- [OS X](#os-x)

- [Windows](#windows)



* * *



### Pre-build configure guide



For a complete list of avaliable configure-time option,

try `configure --help`.



#### Using alternative crypto library



There are three crypto libraries available:



- OpenSSL (**default**)

- mbedTLS

- PolarSSL (Deprecated)



##### mbedTLS

To build against mbedTLS, specify `--with-crypto-library=mbedtls`

and `--with-mbedtls=/path/to/mbedtls` when running `./configure`.



Windows users will need extra work when compiling mbedTLS library,

see [this issue](https://github.com/shadowsocks/shadowsocks-libev/issues/422) for detail info.



##### PolarSSL (Deprecated)



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__.



#### Using shared library from system



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.



### Debian & Ubuntu



#### Install from repository



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



Shadowsocks-libev is available in the official repository for Debian 9("Stretch"), unstable, Ubuntu 16.10 and later derivatives:



```bash

sudo apt update

sudo apt install shadowsocks-libev

```



For Debian Jessie users, please install it from `jessie-backports`:



```bash

sudo sh -c 'printf "deb http://ftp.debian.org/debian jessie-backports main" > /etc/apt/sources.list.d/jessie-backports.list'

sudo apt update

sudo apt -t jessie-backports install shadowsocks-libev

```



#### Build deb package from source



Supported Platforms:



* Debian 7 (see below), 8, 9, 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](http://backports.debian.org).



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](#linux)

section below.



``` bash

cd shadowsocks-libev

sudo apt-get install --no-install-recommends build-essential autoconf libtool libssl-dev \

    gawk debhelper dh-systemd init-system-helpers pkg-config asciidoc xmlto apg libpcre3-dev

dpkg-buildpackage -b -us -uc -i

cd ..

sudo dpkg -i shadowsocks-libev*.deb

```



#### Configure and start the service



```

# 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

```



### Fedora & RHEL



Supported distributions include

- Fedora 22, 23, 24

- RHEL 6, 7 and derivatives (including CentOS, Scientific Linux)



#### Install from repository



Enable repo via `dnf`:



```

su -c 'dnf copr enable librehat/shadowsocks'

```



Or download yum repo on [Fedora Copr](https://copr.fedoraproject.org/coprs/librehat/shadowsocks/) and put it inside `/etc/yum.repos.d/`. The release `Epel` is for RHEL and its derivatives.



Then, install `shadowsocks-libev` via `dnf`:



```bash

su -c 'dnf update'

su -c 'dnf install shadowsocks-libev'

```



or `yum`:



```bash

su -c 'yum update'

su -c 'yum install shadowsocks-libev'

```

### OpenSUSE



#### Install from repository

Use the following command to install from repository.



```bash

sudo zypper install shadowsocks-libev

```



#### Build from source

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



```bash

sudo zypper update

sudo zypper install zlib-devel libopenssl-devel

```



Then download the source package and compile.



```bash

git clone https://github.com/shadowsocks/shadowsocks-libev.git

cd shadowsocks-libev

./configure && make

sudo make install

```



### Archlinux



```bash

sudo pacman -S shadowsocks-libev

```



Please refer to downstream [PKGBUILD](https://projects.archlinux.org/svntogit/community.git/tree/trunk?h=packages/shadowsocks-libev)

script for extra modifications and distribution-specific bugs.



### NixOS



```bash

nix-env -iA nixos.shadowsocks-libev

```



### Nix



```bash

nix-env -iA nixpkgs.shadowsocks-libev

```



### Linux



For Unix-like systems, especially Debian-based systems,

e.g. Ubuntu, Debian or Linux Mint, you can build the binary like this:



```bash

# Debian / Ubuntu

sudo apt-get install --no-install-recommends build-essential autoconf libtool libssl-dev libpcre3-dev asciidoc xmlto

# CentOS / Fedora / RHEL

sudo yum install gcc autoconf libtool automake make zlib-devel openssl-devel asciidoc xmlto

./configure && make

sudo make install

```



### FreeBSD



```bash

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:



```bash

service shadowsocks_libev start

```



### OpenWRT



The OpenWRT project is maintained here:

[openwrt-shadowsocks](https://github.com/shadowsocks/openwrt-shadowsocks).



### OS X

For OS X, use [Homebrew](http://brew.sh) to install or build.



Install Homebrew:



```bash

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

```

Install shadowsocks-libev:



```bash

brew install shadowsocks-libev

```



### 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



```bash

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



```bash

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



```bash

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

make && make install

```



#### PolarSSL



```bash

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

make && make install

```



## Usage



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            host name or ip address of your remote server



       -p            port number of your remote server



       -l             port number of your local server



       -k               password of your remote server



       [-m ]      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 ]            the file path to store pid



       [-t ]             socket timeout in seconds



       [-c ]         the path to config file



       [-i ]           network interface to bind,

                                  not available in redir mode



       [-b ]       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 :]         specify destination server address and port

                                  for local port forwarding,

                                  only available in tunnel mode



       [-d ]                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 ]         config file of ACL (Access Control List)

                                  only available in local and server mode



       [--manager-address ] UNIX domain socket address

                                  only available in server and manager mode



       [--executable ]      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.



```



## 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

    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 route add local default dev lo table 100

    root@Wrt:~# ip rule add fwmark 1 lookup 100

    root@Wrt:~# iptables -t mangle -A SHADOWSOCKS -p udp --dport 53 -j TPROXY --on-port 12345 --tproxy-mark 0x01/0x01

    root@Wrt:~# iptables -t mangle -A SHADOWSOCKS_MARK -p udp --dport 53 -j MARK --set-mark 1



    # Apply the rules

    root@Wrt:~# iptables -t nat -A OUTPUT -p tcp -j SHADOWSOCKS

    root@Wrt:~# iptables -t mangle -A PREROUTING -j SHADOWSOCKS

    root@Wrt:~# iptables -t mangle -A OUTPUT -j SHADOWSOCKS_MARK



    # Start the shadowsocks-redir

    root@Wrt:~# ss-redir -u -c /etc/config/shadowsocks.json -f /var/run/shadowsocks.pid



## Shadowsocks over KCP



It's quite easy to use shadowsocks and [KCP](https://github.com/skywind3000/kcp) together with [kcptun](https://github.com/xtaci/kcptun).



The goal of shadowsocks over KCP is to provide a fully configurable, UDP based protocol to improve poor connections, e.g. a high packet loss 3G network.



### Setup your server



```bash

server_linux_amd64 -l :21 -t 127.0.0.1:443 --crypt none --mtu 1200 --nocomp --mode normal --dscp 46 &

ss-server -s 0.0.0.0 -p 443 -k passwd -m chacha20 -u

```



### Setup your client



```bash

client_linux_amd64 -l 127.0.0.1:1090 -r :21 --crypt none --mtu 1200 --nocomp --mode normal --dscp 46 &

ss-local -s 127.0.0.1 -p 1090 -k passwd -m chacha20 -l 1080 -b 0.0.0.0 &

ss-local -s  -p 443 -k passwd -m chacha20 -l 1080 -U -b 0.0.0.0

```



## Security Tips



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



## License



Copyright (C) 2016 Max Lv 



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 .