wickproxy-light

README

Wickproxy-light

Wickproxy-light is the light version of Wickproxy. It is a lightweight but security HTTP(S)、HTTP2 Proxy with probe resistance. Wickproxy is written in Golang and is under MIT License.

Features

• A Proxy for HTTP, HTTPS and HTTP2. Unlike other proxies, Wickproxy is an HTTP proxy and no client is needed.
• Highly concealed and Probe-Resistance.
  • Rewrite any illegal requests to a backend server.
  • Wickproxy can work as a frontend server application in the front of Caddy or Nginx.
• Access control list. Allow or deny by IP, ports, domain name, or CIDR.
• Build for almost all platforms. Wickproxy is compiled for Windows, OS X, Linux, and Freebsd.

Probe-Resistance

For many HTTP proxy clients, it is common that no authentication information is sent in the first packet, then the server should return a 407 Proxy-Authenticate to indicate the authentication information should be sent. However, this behavior exposes the fact of wickproxy is a proxy server.

In order to resist probe requests, only requests to hide.fallback(such as pr.wickproxy.org will trick a 407 Proxy-Authenticate response and other requests will be fallbacked to backend servers.

However, it is nay not be compatible with some software such as git command. A hide.allowhosts is introduced to solve this problem. Hosts in hide.allowhosts will also trick a 407 Proxy-Authenticate. hide.allowhosts should be used as a workaround and it increases the risk of be detected.

Fallback Model

It is easy to use Wickproxy as the frontend server listening on port 443 or 80. Any invalid requests will be sent to hide.fallback. Then, an Nginx or caddy server listen on fallback.

Download

Download from: Release Page

Build

Prerequisites:

• Golang 1.12 or above
• git to clone this repository

It is easy to build Wickproxy using go command:

git clone https://github.com/ertuil/wickproxy-light
go build -o build/wickproxy .

Another way to compile Wickproxy is to use Make command:

make <platform>       # to build for special platform. Including: linux-amd64, linux-arm64 , darwin-amd64, windows-x64, windows-x86 and freebsd-amd64
make all        # to build for all three platforms

Install

via curl

sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/ertuil/wickproxy-light/main/example/install.sh)"

via wget

sudo bash -c "$(wget -O- https://raw.githubusercontent.com/ertuil/wickproxy-light/main/example/install.sh)"

Usage

Get Help

Command:

wickproxy -h # print help
wickproxy -v # print version
wickproxy -c <config.toml> [-u usage.db] [-l logging.txt]

Please refer to example/config.toml to see how to configure.