Clients – Shadowsocks
WindowsGUI Clientshadowsocks-win: GitHubShadowsocks-Qt5: GitHubOutline WindowsGitHubDirect DownloadCommand-line Clientpip install shadowsocks Mac OS XGUI ClientShadowsocksX-NG: GitHubOutline macOSGitHubApp StoreCommand-line Clientbrew install shadowsocks-libevcpan Net::Shadowsocks LinuxGUI ClientShadowsocks-Qt5: GitHubOutline LinuxGitHubDirect DownloadCommand-line Clientapt-get install shadowsocks-libevcpan Net::Shadowsocks Androidshadowsocks-android:Google Play (beta)Outline AndroidGitHubPlay StoreDirect Download iOSMobileShadowSocks:Big BossOutline iOSGitHubApp Store OpenWRTshadowsocks-libevopkg install shadowsocks-libevshadowsocks-libev-polarsslopkg install shadowsocks-libev-polarsslNext StepReady to use? Just navigate to Quick plan to deploy your own server? See a Minute? Take one minute to complete a survey about shadowsocks user base. It’s totally anonymous and no login required.
Shadowsocks-libev – GitHub
Intro
Shadowsocks-libev is a lightweight secured SOCKS5
proxy for embedded devices and low-end boxes.
It is a port of Shadowsocks
created by @clowwindy, and maintained by
@madeye and @linusyang.
Current version: 3. 3. 5 | Changelog
Features
Shadowsocks-libev is written in pure C and depends on libev. It’s designed
to be a lightweight implementation of shadowsocks protocol, in order to keep the resource usage as low as possible.
For a full list of feature comparison between different versions of shadowsocks,
refer to the Wiki page.
Quick Start
Snap is the recommended way to install the latest binaries.
Install snap core
Install from
Stable channel:
sudo snap install shadowsocks-libev
Edge channel:
sudo snap install shadowsocks-libev –edge
Installation
Distribution-specific guide
Debian & Ubuntu
Install from repository
Build deb package from source
Configure and start the service
Fedora & RHEL
Build from source with centos
Archlinux & Manjaro
NixOS
Nix
Directly build and install on UNIX-like system
FreeBSD
Install
Configuration
Run
Run as client
OpenWRT
OS X
Windows (MinGW)
Docker
Initialise the build environment
This repository uses submodules, so you should pull them before you start, using:
git submodule update –init –recursive
Pre-build configure guide
For a complete list of available configure-time option,
try configure –help.
Install from repository (not recommended)
Shadowsocks-libev is available in the official repository for following distributions:
Debian 8 or higher, including oldoldstable (jessie), old stable (stretch), stable (buster), testing (bullseye) and unstable (sid)
Ubuntu 16. 10 or higher
sudo apt update
sudo apt install shadowsocks-libev
Supported distributions:
Debian 8, 9 or higher
Ubuntu 14. 04 LTS, 16. 10 or higher
You can build shadowsocks-libev and all its dependencies by script:
mkdir -p ~/build-area/
cp. /scripts/ ~/build-area/
cd ~/build-area. /
For older systems, building packages is not supported.
Please try to build and install directly from source. See the Linux section below.
Note for Debian 8 (Jessie) users to build their own deb packages:
We strongly encourage you to install shadowsocks-libev from jessie-backports-sloppy. If you insist on building from source, you will need to manually install libsodium from jessie-backports-sloppy, NOT libsodium in main repository.
For more info about backports, you can refer Debian Backports.
cd shadowsocks-libev
sudo sh -c ‘printf “deb jessie-backports main” > /etc/apt/’
sudo sh -c ‘printf “deb jessie-backports-sloppy main” >> /etc/apt/’
sudo apt-get install –no-install-recommends devscripts equivs
mk-build-deps –root-cmd sudo –install –tool “apt-get -o Debug::pkgProblemResolver=yes –no-install-recommends -y”. / && dpkg-buildpackage -b -us -uc
cd..
sudo dpkg -i shadowsocks-libev*
Note for Debian 9 (Stretch) users to build their own deb packages:
We strongly encourage you to install shadowsocks-libev from stretch-backports. If you insist on building from source, you will need to manually install libsodium from stretch-backports, NOT libsodium in main repository.
sudo sh -c ‘printf “deb stretch-backports main” > /etc/apt/’
# Edit the configuration file
sudo vim /etc/shadowsocks-libev/
# 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
Recent Fedora versions (until EOL)
RHEL 6, 7 and derivatives (including CentOS, Scientific Linux)
If you are using CentOS 7, you need to install these prerequirements to build from source code:
yum install epel-release -y
yum install gcc gettext autoconf libtool automake make pcre-devel asciidoc xmlto c-ares-devel libev-devel libsodium-devel mbedtls-devel -y
sudo pacman -S shadowsocks-libev
Please refer to downstream PKGBUILD
script for extra modifications and distribution-specific bugs.
nix-env -iA adowsocks-libev
Linux
In general, you need the following build dependencies:
autotools (autoconf, automake, libtool)
gettext
pkg-config
libmbedtls
libsodium
libpcre3 (old pcre library)
libev
libc-ares
asciidoc (for documentation only)
xmlto (for documentation only)
Notes: Fedora 26 libsodium version >= 1. 0. 12, so you can install via dnf install libsodium instead build from source.
If your system is too old to provide libmbedtls and libsodium (later than v1. 8), you will need to either install those libraries manually or upgrade your system.
If your system provides with those libraries, you should not install them from source. You should jump this section and install them from distribution repository instead.
For some of the distributions, you might install build dependencies like this:
# Installation of basic build dependencies
## Debian / Ubuntu
sudo apt-get install –no-install-recommends gettext build-essential autoconf libtool libpcre3-dev asciidoc xmlto libev-dev libc-ares-dev automake libmbedtls-dev libsodium-dev
## CentOS / Fedora / RHEL
sudo yum install gettext gcc autoconf libtool automake make asciidoc xmlto c-ares-devel libev-devel
## Arch
sudo pacman -S gettext gcc autoconf libtool automake make asciidoc xmlto c-ares libev
# Installation of libsodium
export LIBSODIUM_VER=1. 16
wget
tar xvf libsodium-$
pushd libsodium-$LIBSODIUM_VER. /configure –prefix=/usr && make
sudo make install
popd
sudo ldconfig
# Installation of MbedTLS
export MBEDTLS_VER=2. 6. 0
tar xvf mbedtls-$
pushd mbedtls-$MBEDTLS_VER
make SHARED=1 CFLAGS=”-O2 -fPIC”
sudo make DESTDIR=/usr install
# Start building. / &&. /configure && make
You may need to manually install missing softwares.
Shadowsocks-libev is available in FreeBSD Ports Collection. You can install it in either way, pkg or ports.
pkg (recommended)
pkg install shadowsocks-libev
ports
cd /usr/ports/net/shadowsocks-libev
make install
Edit your file. By default, it’s located in /usr/local/etc/shadowsocks-libev.
To enable shadowsocks-libev, add the following rc variable to your /etc/ file:
shadowsocks_libev_enable=”YES”
Start the Shadowsocks server:
service shadowsocks_libev start
By default, shadowsocks-libev is running as a server in FreeBSD. If you would like to start shadowsocks-libev in client mode, you can modify the rc script (/usr/local/etc/rc. d/shadowsocks_libev) manually.
# modify the following line from “ss-server” to “ss-local”
command=”/usr/local/bin/ss-local”
Note that is simply a workaround, each time you upgrade the port your changes will be overwritten by the new version.
The OpenWRT project is maintained here:
openwrt-shadowsocks.
For OS X, use Homebrew to install or build.
Install Homebrew:
ruby -e “$(curl -fsSL)”
Install shadowsocks-libev:
brew install shadowsocks-libev
To build Windows native binaries, the recommended method is to use Docker:
On Windows: double-click in dockermingw
On Unix-like system:
cd shadowsocks-libev/docker/mingw
make
A tarball with 32-bit and 64-bit binaries will be generated in the same directory.
You could also manually use MinGW-w64 compilers to build in Unix-like shell (MSYS2/Cygwin), or cross-compile on Unix-like systems (Linux/MacOS). Please refer to build scripts in docker/mingw.
Currently you need to use a patched libev library for MinGW:
Notice that TCP Fast Open (TFO) is only available on Windows 10, 1607 or later version (precisely, build >= 14393). If you are using 1709 (build 16299) or later version, you also need to run the following command in PowerShell/Command Prompt as Administrator and reboot to use TFO properly:
netsh int tcp set global fastopenfallback=disabled
As you expect, simply pull the image and run.
docker pull shadowsocks/shadowsocks-libev
docker run -e PASSWORD=
More information about the image can be found here.
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|manager]
-s
-p
-l
-k
-m
aes-128-gcm, aes-192-gcm, aes-256-gcm,
aes-128-cfb, aes-192-cfb, aes-256-cfb,
aes-128-ctr, aes-192-ctr, aes-256-ctr,
camellia-128-cfb, camellia-192-cfb,
camellia-256-cfb, bf-cfb,
chacha20-ietf-poly1305,
xchacha20-ietf-poly1305,
salsa20, chacha20 and chacha20-ietf.
The default cipher is chacha20-ietf-poly1305.
[-a
[-f
[-t
[-c
[-n
[-i
(not available in redir mode)
[-b
For servers: Specify the local address to use
while this server is making outbound
connections to remote servers on behalf of the
clients.
For clients: Specify the local address to use
while this client is making outbound
connections to the server.
[-u] Enable UDP relay.
(TPROXY is required in redir mode)
[-U] Enable UDP relay and disable TCP relay.
(not available in local mode)
[-T] Use tproxy instead of redirect. (for tcp)
(only available in redir mode)
[-L
for local port forwarding.
(only available in tunnel mode)
[-6] Resolve hostname to IPv6 address first.
[-d
(only available in server mode)
[–reuse-port] Enable port reuse.
[–fast-open] Enable TCP fast open.
with Linux kernel > 3. 7. 0.
(only available in local and server mode)
[–acl
[–manager-address
(only available in server and manager mode)
[–mtu
[–mptcp] Enable Multipath TCP on MPTCP Kernel.
[–no-delay] Enable TCP_NODELAY.
[–executable
(only available in manager mode)
[-D
[–key
[–plugin
[–plugin-opts
[-v] Verbose mode.
Transparent proxy
The latest shadowsocks-libev has provided a redir mode. You can configure your Linux-based box or router to proxy all TCP traffic transparently, which is handy if you use an OpenWRT-powered router.
# Create new chain
iptables -t nat -N SHADOWSOCKS
iptables -t mangle -N SHADOWSOCKS
# Ignore your shadowsocks server’s addresses
# It’s very IMPORTANT, just be careful.
iptables -t nat -A SHADOWSOCKS -d 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.
iptables -t nat -A SHADOWSOCKS -d 0. 0/8 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 10. 0/8 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 127. 0/8 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 169. 254. 0/16 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 172. 16. 0/12 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 192. 168. 0/16 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 224. 0/4 -j RETURN
iptables -t nat -A SHADOWSOCKS -d 240. 0/4 -j RETURN
# Anything else should be redirected to shadowsocks’s local port
iptables -t nat -A SHADOWSOCKS -p tcp -j REDIRECT –to-ports 12345
# Add any UDP rules
ip route add local default dev lo table 100
ip rule add fwmark 1 lookup 100
iptables -t mangle -A SHADOWSOCKS -p udp –dport 53 -j TPROXY –on-port 12345 –tproxy-mark 0x01/0x01
# Apply the rules
iptables -t nat -A PREROUTING -p tcp -j SHADOWSOCKS
iptables -t mangle -A PREROUTING -j SHADOWSOCKS
# Start the shadowsocks-redir
ss-redir -u -c /etc/config/ -f /var/run/
Transparent proxy (pure tproxy)
Executing this script on the linux host can proxy all outgoing traffic of this machine (except the traffic sent to the reserved address). Other hosts under the same LAN can also change their default gateway to the ip of this linux host (at the same time change the dns server to 1. 1. 1 or 8. 8. 8, etc. ) to proxy their outgoing traffic.
Of course, the ipv6 proxy is similar, just change iptables to ip6tables, ip to ip -6, 127. 1 to::1, and other details.
#! /bin/bash
start_ssredir() {
# please modify MyIP, MyPort, etc.
(ss-redir -s MyIP -p MyPort -m MyMethod -k MyPasswd -b 127. 1 -l 60080 –no-delay -u -T -v >/var/log/ &)}
stop_ssredir() {
kill -9 $(pidof ss-redir) &>/dev/null}
start_iptables() {
##################### SSREDIR #####################
iptables -t mangle -N SSREDIR
# connection-mark -> packet-mark
iptables -t mangle -A SSREDIR -j CONNMARK –restore-mark
iptables -t mangle -A SSREDIR -m mark –mark 0x2333 -j RETURN
# ignore traffic sent to ss-server
iptables -t mangle -A SSREDIR -p tcp -d MyIP –dport MyPort -j RETURN
iptables -t mangle -A SSREDIR -p udp -d MyIP –dport MyPort -j RETURN
# ignore traffic sent to reserved addresses
iptables -t mangle -A SSREDIR -d 0. 0/8 -j RETURN
iptables -t mangle -A SSREDIR -d 10. 0/8 -j RETURN
iptables -t mangle -A SSREDIR -d 100. 64. 0/10 -j RETURN
iptables -t mangle -A SSREDIR -d 127. 0/8 -j RETURN
iptables -t mangle -A SSREDIR -d 169. 0/16 -j RETURN
iptables -t mangle -A SSREDIR -d 172. 0/12 -j RETURN
iptables -t mangle -A SSREDIR -d 192. 0/24 -j RETURN
iptables -t mangle -A SSREDIR -d 192. 2. 88. 99. 0/16 -j RETURN
iptables -t mangle -A SSREDIR -d 198. 18. 0/15 -j RETURN
iptables -t mangle -A SSREDIR -d 198. 51. 100. 0/24 -j RETURN
iptables -t mangle -A SSREDIR -d 203. 113. 0/24 -j RETURN
iptables -t mangle -A SSREDIR -d 224. 0/4 -j RETURN
iptables -t mangle -A SSREDIR -d 240. 0/4 -j RETURN
iptables -t mangle -A SSREDIR -d 255. 255. 255/32 -j RETURN
# mark the first packet of the connection
iptables -t mangle -A SSREDIR -p tcp –syn -j MARK –set-mark 0x2333
iptables -t mangle -A SSREDIR -p udp -m conntrack –ctstate NEW -j MARK –set-mark 0x2333
# packet-mark -> connection-mark
iptables -t mangle -A SSREDIR -j CONNMARK –save-mark
##################### OUTPUT #####################
# proxy the outgoing traffic from this machine
iptables -t mangle -A OUTPUT -p tcp -m addrtype –src-type LOCAL! –dst-type LOCAL -j SSREDIR
iptables -t mangle -A OUTPUT -p udp -m addrtype –src-type LOCAL! –dst-type LOCAL -j SSREDIR
##################### PREROUTING #####################
# proxy traffic passing through this machine (other->other)
iptables -t mangle -A PREROUTING -p tcp -m addrtype! –src-type LOCAL! –dst-type LOCAL -j SSREDIR
iptables -t mangle -A PREROUTING -p udp -m addrtype! –src-type LOCAL! –dst-type LOCAL -j SSREDIR
# hand over the marked package to TPROXY for processing
iptables -t mangle -A PREROUTING -p tcp -m mark –mark 0x2333 -j TPROXY –on-ip 127. 1 –on-port 60080
iptables -t mangle -A PREROUTING -p udp -m mark –mark 0x2333 -j TPROXY –on-ip 127. 1 –on-port 60080}
stop_iptables() {
iptables -t mangle -D PREROUTING -p tcp -m mark –mark 0x2333 -j TPROXY –on-ip 127. 1 –on-port 60080 &>/dev/null
iptables -t mangle -D PREROUTING -p udp -m mark –mark 0x2333 -j TPROXY –on-ip 127. 1 –on-port 60080 &>/dev/null
iptables -t mangle -D PREROUTING -p tcp -m addrtype! –src-type LOCAL! –dst-type LOCAL -j SSREDIR &>/dev/null
iptables -t mangle -D PREROUTING -p udp -m addrtype! –src-type LOCAL! –dst-type LOCAL -j SSREDIR &>/dev/null
iptables -t mangle -D OUTPUT -p tcp -m addrtype –src-type LOCAL! –dst-type LOCAL -j SSREDIR &>/dev/null
iptables -t mangle -D OUTPUT -p udp -m addrtype –src-type LOCAL! –dst-type LOCAL -j SSREDIR &>/dev/null
iptables -t mangle -F SSREDIR &>/dev/null
iptables -t mangle -X SSREDIR &>/dev/null}
start_iproute2() {
ip rule add fwmark 0x2333 table 100}
stop_iproute2() {
ip rule del table 100 &>/dev/null
ip route flush table 100 &>/dev/null}
start_resolvconf() {
# or nameserver 8. 8, etc.
echo “nameserver 1. 1” >/etc/}
stop_resolvconf() {
echo “nameserver 114. 114. 114” >/etc/}
start() {
echo “start… ”
start_ssredir
start_iptables
start_iproute2
start_resolvconf
echo “start end”}
stop() {
echo “stop… ”
stop_resolvconf
stop_iproute2
stop_iptables
stop_ssredir
echo “stop end”}
restart() {
stop
sleep 1
start}
main() {
if [ $# -eq 0]; then
echo “usage: $0 start|stop|restart… ”
return 1
fi
for funcname in “$@”; do
if [ “$(type -t $funcname)”! = ‘function’]; then
echo “‘$funcname’ not a shell function”
done
$funcname
return 0}
main “$@”
Security Tips
For any public server, to avoid users accessing localhost of your server, please add –acl acl/ to the command line.
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: 2013-2015, Clow Windy <>
2013-2018, Max Lv <>
2014, Linus Yang <>
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 <>.
Install And Use Shadowsocks Command Line Client on Linux
In a previous post, I showed you how to build a shadowsocks server on your own server and install the client software on your Linux, Windows, and Mac Desktop. And also on your Android and iOS devices. This article will show you how to install and use the command line client on Linux including Debian, Ubuntu, Fedora, CentOS, OpenSUSE and Archlinux.
Install the Command Line Client
If you prefer command line client, then you can install it on your Linux with the following command.
Debian
sudo apt-get install python-pip
sudo pip install shadowsocks
Ubuntu
Yes, you can use the above commands to install shadowsocks client on ubuntu. But it will install it under ~/ directory and it causes loads of trouble. So I suggest using su to become root first and then issue the following two commands.
apt-get install python-pip
pip install shadowsocks
Fedora/Centos
sudo yum install python-setuptools or sudo dnf install python-setuptools
sudo easy_install pip
OpenSUSE
sudo zypper install python-pip
Archlinux
sudo pacman -S python-pip
As you can see the command of installing shadowsocks client is the same to the command of installing shadowsocks server, because the above command will install both the client and the server. You can verify this by looking at the installation script output
Downloading/unpacking shadowsocks
Downloading
Running (path:/tmp/pip-build-PQIgUg/shadowsocks/) egg_info for package shadowsocks
Installing collected packages: shadowsocks
Running install for shadowsocks
Installing sslocal script to /usr/local/bin
Installing ssserver script to /usr/local/bin
Successfully installed shadowsocks
Cleaning up…
sslocal is the client software and ssserver is the server software. On some Linux distros such as ubuntu, the shadowsocks client sslocal is installed under /usr/local/bin. On Others such as Arch sslocal is installed under /usr/bin/. Your can use whereis command to find the exact location.
[email protected]:~$ whereis sslocal
sslocal: /usr/local/bin/sslocal
Create a Configuration File
we will create a configuration file under /etc/
sudo vi /etc/
Put the following text in the file. Replace server-ip with your actual IP and set a password.
{
“server”:”server-ip”,
“server_port”:8000,
“local_address”: “127. 0. 1”,
“local_port”:1080,
“password”:”your-password”,
“timeout”:600,
“method”:”aes-256-cfb”}
Save and close the file. Next start the client using command line
sslocal -c /etc/
To run in the background
sudo sslocal -c /etc/ -d start
Auto Start the Client on System Boot
Edit /etc/ file
Put the following line above the exit 0 line:
Save and close the file. Next time you start your computer, shadowsocks client will automatically start and connect to your shadowsocks server.
Check if It Works
After you rebooted your computer, enter the following command in terminal:
sudo systemctl status rvice
If your sslocal command works then you will get this ouput:
● rvice – /etc/ Compatibility
Loaded: loaded (/etc/systemd/system/rvice; enabled; vendor preset: enabled)
Active: active (running) since Fri 2015-11-27 03:19:25 CST; 2min 39s ago
Process: 881 ExecStart=/etc/ start (code=exited, status=0/SUCCESS)
CGroup: /
├─ 887 watch -n 60 su matrix -c ibam
└─1112 /usr/bin/python /usr/local/bin/sslocal -c /etc/shadowsocks….
As you can see from the last line, the sslocal command created a process whose pid is 1112 on my machine. It means shadowsocks client is running smoothly. And of course you can tell your browser to connect through your shadowsocks client to see if everything goes well.
If for some reason your /etc/ script won’t run, then check the following post to find the solution.
How to enable /etc/ with Systemd
Frequently Asked Questions about shadowsocks linux
How do I use Shadowsocks in Linux?
Shadowsocks Setup Guide for LinuxAfter the installation is complete, click on the Menu button and type in ‘Shadowsocks’ in the search bar. … On the Menu Bar, click on Connection -> Add -> URL. … Click on OK. … Right-click on the server that you have just added and select Connect.More items…
How do I use Shadowsocks on Mac?
macOS – Setup ShadowSocks PrintDownload Shadowsocks for macOS from HERE.Extract the .ZIP file.Move the ShadowsocksX-NG to the applications folder.Go to your applications and launch Shadowssocks-NG. … Right click on the shadowsocks icon > servers > server preferences.Enter in the server name, port, password and a name.More items…
Is Shadowsocks a proxy?
Shadowsocks is based on a technique called proxying. … It creates an encrypted connection between the Shadowsocks client on your local computer and the one running on your proxy server, using an open-source internet protocol called SOCKS5.Sep 19, 2017