Skip to main content

Proxy server that can tunnel among remote servers by regex rules.

Project description

made-with-python PyPI-version Hit-Count GitHub-stars

HTTP/Socks4/Socks5/Shadowsocks/ShadowsocksR/Redirect asynchronous tunnel proxy implemented in Python3 asyncio.

QuickStart

$ pip3 install pproxy
Successfully installed pproxy-1.6
$ pproxy
Serving on :8080 by http,socks4,socks5
^C
$ pproxy -i ss://chacha20:abc@:8080
Serving on :8080 by ss (chacha20-py)

Optional: (better performance with C ciphers)

$ pip3 install pycryptodome
Successfully installed pycryptodome-3.6.4
$ pproxy -i ss://chacha20:abc@:8080
Serving on :8080 by ss (chacha20)

Features

  • Single-thread asynchronous IO with high availability and scalability.

  • Lightweight (~500 lines) and powerful by leveraging python builtin asyncio library.

  • No additional library is required. All codes are in pure Python.

  • Auto-detect incoming traffic.

  • Tunnel by remote proxy servers.

  • Tunnel and relay with several layers.

  • Unix domain path socket.

  • Basic authentication for all protocols.

  • Regex pattern file to route/block by hostname.

  • SSL client/server support.

  • Built-in encryption ciphers. (chacha20, aes-256-cfb, etc)

  • Shadowsocks OTA (One-Time-Auth).

  • SSR plugins. (http_simple, verify_simple, tls1.2_ticket_auth, etc)

  • Statistics by bandwidth and traffic.

  • PAC support for javascript configuration.

  • Iptables NAT redirect packet tunnel.

  • PyPy3 support with JIT speedup.

  • System proxy auto-setting support.

Python3

Python 3.5 added new syntax async def and await to make asyncio programming easier. Python 3.6 added new syntax formatted string literals. This tool was to demonstrate these new syntax, so the minimal Python requirement was 3.6.

From pproxy 1.1.0, the minimal Python requirement is 3.3, since old python versions are still widely used and PyPy3 only has 3.3 support currently. Python 2 will not be supported in the future.

From proxy 1.3.0, the minimal Python requirement is 3.6, since Python 3.7 make the async/await/ reserved words, we cannot make pproxy compatible with older versions.

PyPy3

$ pypy3 -m ensurepip
$ pypy3 -m pip install asyncio pproxy

Requirement

pycryptodome is an optional library to enable faster (C version) cipher. pproxy has many built-in pure python ciphers. They are lightweight and stable, but slower than C ciphers. After speedup with PyPy, the pure python ciphers can get similar performance as C version. If the performance is important and don’t have PyPy, install pycryptodome instead.

These are some performance benchmarks between Python and C ciphers (dataset: 8M):

chacha20-c

0.64 secs

chacha20-py (pypy3)

1.32 secs

chacha20-py

48.86 secs

Usage

$ pproxy -h
usage: pproxy [-h] [-i LISTEN] [-r RSERVER] [-b BLOCK] [-a ALIVED] [-v]
              [--ssl SSLFILE] [--pac PAC] [--get GETS] [--sys]
              [--test TESTURL] [--version]

Proxy server that can tunnel among remote servers by regex rules. Supported
protocols: http,socks4,socks5,shadowsocks,shadowsocksr,redirect

optional arguments:
  -h, --help     show this help message and exit
  -i LISTEN      proxy server setting uri (default: http+socks://:8080/)
  -r RSERVER     remote server setting uri (default: direct)
  -b BLOCK       block regex rules
  -a ALIVED      interval to check remote alive (default: no check)
  -v             print verbose output
  --ssl SSLFILE  certfile[,keyfile] if server listen in ssl mode
  --pac PAC      http PAC path
  --get GETS     http custom {path,file}
  --sys          change system proxy setting (mac, windows)
  --test TEST    test this url for all remote proxies and exit
  --version      show program's version number and exit

Online help: <https://github.com/qwj/python-proxy>

URI Syntax

{scheme}://[{cipher}@]{netloc}/[@{localbind}][,{plugins}][?{rules}][#{auth}]

  • scheme
    • Currently supported scheme: http, socks, ss, ssl, secure. You can use + to link multiple protocols together.

      http

      http protocol

      socks4

      socks4 protocol

      socks5

      socks5 protocol

      ss

      shadowsocks protocol

      ssr

      shadowsocksr (SSR) protocol

      redir

      redirect (iptables nat)

      ssl

      unsecured ssl (no cert)

      secure

      secured ssl (required cert)

      direct

      direct connection

    • Valid schemes: http://, http+socks4+socks5://, http+ssl://, ss+secure://, http+socks5+ss://

    • Invalid schemes: ssl://, secure://

  • cipher
    • Cipher is consisted by cipher name, colon ‘:’ and cipher key.

    • Full supported cipher list: (Pure python ciphers has ciphername suffix -py)

      Cipher

      Key Length

      IV Length

      Score (0-5)

      table-py

      any

      0

      0 (lowest)

      rc4

      16

      0

      0 (lowest)

      rc4-md5

      16

      16

      0.5

      chacha20

      32

      8

      5 (highest)

      chacha20-ietf

      32

      12

      5

      chacha20-ietf- poly1305-py

      32

      32

      AEAD

      salsa20

      32

      8

      4.5

      aes-128-cfb

      aes-128-cfb8

      aes-128-cfb1-py

      16

      16

      3

      slow

      aes-192-cfb

      aes-192-cfb8

      aes-192-cfb1-py

      24

      16

      3.5

      slow

      aes-256-cfb

      aes-256-ctr

      aes-256-ofb

      aes-256-cfb8

      aes-256-cfb1-py

      32

      16

      4.5

      slow

      aes-256-gcm

      aes-192-gcm

      aes-128-gcm

      32

      24

      16

      32

      24

      16

      AEAD

      AEAD

      AEAD

      camellia-256-cfb

      camellia-192-cfb

      camellia-128-cfb

      32

      24

      16

      16

      16

      16

      4

      4

      4

      bf-cfb

      16

      8

      1

      cast5-cfb

      16

      8

      2.5

      des-cfb

      8

      8

      1.5

      rc2-cfb-py

      16

      8

      2

      idea-cfb-py

      16

      8

      2.5

      seed-cfb-py

      16

      16

      2

    • All ciphers have pure python implementations. If there is C implementation available within pycryptodome, program will switch to C version cipher.

    • AEAD ciphers use additional payload after each packet. The underlying protocol is different. Specifications: AEAD.

    • Some pure python ciphers (aes-256-cfb1-py) is quite slow, and is not recommended to use without PyPy speedup. Try install pycryptodome and use C version cipher instead.

    • To enable OTA encryption with shadowsocks, add ‘!’ immediately after cipher name.

  • netloc
    • It can be “hostname:port” or “/unix_domain_path”. If the hostname is empty, server will listen on all interfaces.

    • Valid netloc: localhost:8080, 0.0.0.0:8123, /tmp/domain_socket, :8123

  • localbind
    • It can be “@in” or @ipv4_address or @ipv6_address

    • Valid localbind: @in, @192.168.1.15, @::1

  • plugins
    • It can be multiple plugins joined by “,”. Supported plugins: plain, origin, http_simple, tls1.2_ticket_auth, verify_simple, verify_deflate

    • Valid plugins: /,tls1.2_ticket_auth,verify_simple

  • rules
    • The filename that contains regex rules

  • auth
    • The username, colon ‘:’, and the password

URIs can be joined by “__” to indicate tunneling by relay. For example, ss://1.2.3.4:1324__http://4.5.6.7:4321 make remote connection to the first shadowsocks proxy server, and then tunnel to the second http proxy server.

Examples

Define regex file “rules” as follow:

#google domains
(?:.+\.)?google.*\.com
(?:.+\.)?gstatic\.com
(?:.+\.)?gmail\.com
(?:.+\.)?ntp\.org
(?:.+\.)?glpals\.com
(?:.+\.)?akamai.*\.net
(?:.+\.)?ggpht\.com
(?:.+\.)?android\.com
(?:.+\.)?gvt1\.com
(?:.+\.)?youtube.*\.com
(?:.+\.)?ytimg\.com
(?:.+\.)?goo\.gl
(?:.+\.)?youtu\.be
(?:.+\.)?google\..+

Then start the pproxy

$ pproxy -i http+socks://:8080 -r http://aa.bb.cc.dd:8080?rules -v
http www.googleapis.com:443 -> http aa.bb.cc.dd:8080
socks www.youtube.com:443 -> http aa.bb.cc.dd:8080
http www.yahoo.com:80
DIRECT: 1 (0.5K/s,1.2M/s)   PROXY: 2 (24.3K/s,1.9M/s)

pproxy will serve incoming traffic by auto-detect http/socks5 protocol, redirect all google traffic to http proxy aa.bb.cc.dd:8080, and visit all other traffic directly from local server.

Add cipher encryption to make sure data can’t be intercepted. Run pproxy locally as:

$ pproxy -i ss://:8888 -r ss://chacha20:cipher_key@aa.bb.cc.dd:12345 -v

Next, run pproxy.py remotely on server “aa.bb.cc.dd”

$ pproxy -i ss://chacha20:cipher_key@:12345

The traffic between local and aa.bb.cc.dd is encrypted by stream cipher Chacha20 with key “cipher_key”.

A more complex example:

$ pproxy -i ss://salsa20!:complex_cipher_key@/tmp/pproxy_socket -r http+ssl://domain1.com:443#username:password

pproxy listen on the unix domain socket “/tmp/pproxy_socket” with cipher “salsa20” and key “complex_cipher_key”. OTA packet protocol is enabled by adding ! after cipher name. The traffic is tunneled to remote https proxy with simple http authentication.

If you want to listen in SSL, you must specify ssl certificate and private key files by parameter “–ssl”:

$ pproxy -i http+ssl://0.0.0.0:443 -i http://0.0.0.0:80 --ssl server.crt,server.key --pac /autopac

pproxy listen on both 80 HTTP and 443 HTTPS ports, use the specified SSL certificate and private key files. The “–pac” enable PAC feature, so you can put “https://yourdomain.com/”” path in your device’s auto-configure url.

ShadowsocksR example with plugin “tls1.2_ticket_auth” to emulate common tls traffic:

$ pproxy -i ssr://chacha20:mypass@0.0.0.0:443/,tls1.2_ticket_auth,verify_simple

If you want to route the traffic by different local bind, use the @localbind URI syntax. For example, server has three ip interfaces: 192.168.1.15, 111.0.0.1, 112.0.0.1. You want to route traffic matched by “rule1” to 111.0.0.2 and traffic matched by “rule2” to 222.0.0.2, and the remaining traffic directly:

$ pproxy -i ss://:8000/@in -r ss://111.0.0.2:8000/@111.0.0.1?rule1 -r ss://222.0.0.2:8000/@222.0.0.1?rule2

IPtable NAT redirect example:

$ sudo iptables -t nat -A OUTPUT -p tcp --dport 80 -j REDIRECT --to-ports 5555
$ pproxy -i redir://:5555 -r http://remote_http_server:3128 -v

The above example illustrates how to redirect all local output tcp traffic with destination port 80 to localhost port 5555 listened by pproxy, and then tunnel the traffic to remote http proxy.

Relay tunnel example:

$ pproxy -r http://server1__ss://server2__socks://server3

pproxy will try to connect to server1 first, tell server1 proxy tunnel to server2, and tell server2 proxy tunnel to server3, and make traffic by server3.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pproxy-1.6.3.tar.gz (30.9 kB view hashes)

Uploaded Source

Built Distribution

pproxy-1.6.3-py3-none-any.whl (27.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page