Archives/Cloak
2
0
Fork 0
mirror of https://github.com/cbeuw/Cloak.git synced 2024-11-03 23:15:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
A censorship circumvention tool to evade detection by authoritarian state adversaries
50 Commits 6 Branches 35 Tags 1.3 MiB
Go 99.4%
Shell 0.4%
Makefile 0.2%
f3f3042c81
Go to file
Qian Wang f3f3042c81 Remove redundant functions
2018-12-31 11:30:39 +00:00
cmd Client auto-reconnect 2018-12-30 21:36:44 +00:00
config User can now specify the path of db file and backups 2018-12-30 00:18:50 +00:00
internal Remove redundant functions 2018-12-31 11:30:39 +00:00
Makefile Done some TODOs 2018-12-22 23:58:03 +00:00
README.md Update README.md 2018-12-30 22:30:45 +00:00
release.sh Add release script 2018-12-30 22:42:51 +00:00

README.md

Cloak

A shadowsocks plugin that obfuscates the traffic as normal HTTPS traffic and disguises the proxy server as a normal webserver.

This is an active WIP. Everything is subject to change.

This project is based on GoQuiet. The most significant difference is that, in GoQuiet, a new TCP connection is establieshed and a TLS handshake is done between the client and the proxy server each time a connection is made to ssclient, whereas in Cloak all the traffic is multiplexed through a fixed amount of consistant TCP connections between the client and the proxy server. The major benefits are:

  • Significantly quicker establishment of new connections as TLS handshake is only done on the startup of the client

  • More realistic traffic pattern

Besides, Cloak allows multiple users to use one server on a single port. QoS restrictions such as bandwidth limitation and data cap can also be managed.

Build

Simply make client and make server. Output binary will be in the build folder

Setup

For the administrator of the server

  1. Install and configure shadowsocks-libev on your server
  2. Clone this repo onto your server
  3. Build and run ck-server -k. The base64 string before the comma is the public key, the one after the comma is the private key
  4. Run ck-server -u. This will be used as the AdminUID
  5. Put the private key and the AdminUID you obtained previously into config/ckserver.json
  6. Edit the configuration file of shadowsocks-libev (default location is /etc/shadowsocks-libev/config.json). Let server_port be 443, plugin be the full path to the ck-server binary and plugin_opts be the full path to ckserver.json. If the fields plugin and plugin_opts were not present originally, add these fields to the config file.
  7. Run ss-server as root (because we are binding to TCP port 443)

If you want to add more users

  1. Run ck-server -u to generate a new UID
  2. On your client, run ck-client -a -c <path-to-ckclient.json> to enter admin mode
  3. Input as prompted, that is your ip:port of the server and your AdminUID. Enter 4 to create a new user.
  4. Enter the UID in your ckclient.json as the prompted UID, enter SessionsCap (maximum amount of concurrent sessions a user can have), UpRate and DownRate (in bytes/s), UpCredit and DownCredit (in bytes) and ExpiryTime (as a unix epoch)
  5. Give your PUBLIC key and the newly generated UID to the new user

Note: the user database is persistent as it's in-disk. You don't need to add the users again each time you start ck-server.

Instructions for clients

  1. Install and configure a version of shadowsocks client that supports plugins (such as shadowsocks-libev and shadowsocks-windows)
  2. Clone this repo and build ck-client
  3. Obtain the PUBLIC key and your UID (or the AdminUID, if you are the server admin) from the administrator of your server
  4. Put the public key and the UID you obtained into config/ckclient.json
  5. Configure your shadowsocks client with your server information. The field plugin should be the path to ck-server binary and plugin_opts should be the path to ckclient.json