simple-proxy

README

Simple Proxy

This is a simple HTTP/HTTPS proxy - designed to be distributed as a self-contained binary that can be dropped in anywhere and run.

Code based on the guide here: https://medium.com/@mlowicki/http-s-proxy-in-golang-in-less-than-100-lines-of-code-6a51c2f2c38c

Features

• HTTP and HTTPS
• Can choose which port to run on
• Can specify paths to certificate and private key file to use
• Logs each proxied connection
• Log options can be supplied using glog
  • Can choose the log verbosity with the -v flag
  • Can choose to log to a file
• Basic authentication
• Can log request headers
• Can log failed authentication attempt details
• Printing version number
• Tunnelling HTTP proxy to SOCKS5 proxy

Install

You can download the latest release for your architecture and operating system from the releases page.

Once you unzip the release package you can either run the binary directly, or you can add it into your PATH so it can be called from anywhere (e.g. the /usr/bin directory).

Linux AMD64

You can use wget to download and install the program to your /usr/bin directory by running these commands:

wget https://github.com/jthomperoo/simple-proxy/releases/download/v1.3.0/simple-proxy_linux_amd64.zip
unzip -d simple-proxy simple-proxy_linux_amd64.zip
cp simple-proxy/simple-proxy /usr/bin/simple-proxy
rm -r simple-proxy/ simple-proxy_linux_amd64.zip

Usage

You can download the binary and run the program directly (it is fully self contained).

Linux/MacOS

You can run the binary directly:

./simple-proxy

Windows

You can run the binary directly:

simple-proxy.exe

Options

The program has the following options, you can see this list by using the --help flag.

Usage of simple-proxy:
  -alsologtostderr
    	log to standard error as well as files
  -basic-auth string
    	basic auth, format 'username:password', no auth if not provided
  -bind string
    	address to bind the proxy server to (default "0.0.0.0")
  -cert string
    	path to cert file
  -key string
    	path to key file
  -log-auth
    	log failed proxy auth details
  -log-headers
    	log request headers
  -log_backtrace_at value
    	when logging hits line file:N, emit a stack trace
  -log_dir string
    	If non-empty, write log files in this directory
  -logtostderr
    	log to standard error instead of files
  -port string
    	proxy port to listen on (default "8888")
  -protocol string
    	proxy protocol (http or https) (default "http")
  -socks5 string
    	SOCKS5 proxy for tunneling, not used if not provided
  -socks5-auth string
    	basic auth for socks5, format 'username:password', no auth if not provided
  -stderrthreshold value
    	logs at or above this threshold go to stderr
  -timeout int
    	timeout in seconds (default 10)
  -v value
    	log level for V logs
  -version
    	prints current simple-proxy version
  -vmodule value
    	comma-separated list of pattern=N settings for file-filtered logging

Checking the proxy is working

You can use cURL on Linux/MacOS systems to check if your proxy is working:

curl --proxy 'http://localhost:8888' 'https://www.random.org/integers/?num=1&min=1&max=5&col=1&base=10&format=plain&rnd=new'

This will reach out to random.org to fetch a random number, using the default proxy address and port.

On Windows you can use:

curl.exe --proxy 'http://localhost:8888' 'https://www.random.org/integers/?num=1&min=1&max=5&col=1&base=10&format=plain&rnd=new'

Contributing

See the CONTRIBUTING and CODE OF CONDUCT documents.