Socks5/HTTP proxy written in Erlang
Erlang Shell Makefile
Latest commit 1f423f2 Sep 11, 2016 @yueyoum fix

README.md

Socks5 proxy written in Erlang

Intro

This project can take you through a Firewall via Socks5 proxy.

Features

with the great erlang, the project has the following features:

  • socks5 / http proxy. (https not supported)

  • Robustness. never down.

  • Scalable. handle thousands requests at the same time easily.

  • Fast.

  • Lightweight. only takes less than 20MB memories.

Running status

In my daily use, (1 cpu, 512MB RAM VPS)

  • Play 2 youtube 1080P video at the same time, It only takes 16MB memories.

    system status

Illustrate

+------------+            +--------------+          
| local app  |  <=======> | proxy client | <#######
+------------+            +--------------+        #
                                                  #
                                                  #
                                                  # encrypted data
                                                  #
                                                  #
+-------------+            +--------------+       #
| target host |  <=======> | proxy server |  <#####
+-------------+            +--------------+         
  1. proxy client is running at your local computer.

    It receive your app (like a browser) request, encrypt the data, send to proxy server

  2. proxy server receive the request from proxy client, decrypt it, and sent to the target host.

  3. proxy server got the response from target host, then encrypt response, send back to proxy client.

  4. proxy client decrypt response received from proxy server, and send to local app.

  5. the circle done.

Usage

Server side

  1. git clone https://github.com/yueyoum/make-proxy.git or directly download.

  2. cd make-proxy

  3. cp server.config.example server.config,

    server.config

    • port. which port that the server listen on
    • key. key to encrypt/decrypt data 16bytes
  4. make server

  5. ./start_server.sh
  6. Done.

Local side

  1. same as the Server side, checkout the code.

  2. cd make-proxy

  3. cp client.config.example client.config

    client.config

    • remote_addr. IP of the compute where make-proxy server runs
    • remote_port. PORT that make-proxy server using. SAME as the defination of server.config.
    • local_socks5_port. this port is used for socks5 proxy.
    • local_http_port. this port is used for http proxy.
    • key. key to encrypt/decrypt data. this MUST AS SAME AS the defination of server.config.
  4. make client

  5. ./start_client.sh

  6. Done

Now, you can set your apps (e.g. Browser) Using socks5 proxy.

IP = 127.0.0.1 PORT = 7070 (if not changed in the client.config)

TODO

  1. Support Socks5 Username/Password Authorize
  2. Traffic Statistics