pfctl support

qwj · web-flow · commit b99497125147 · 2018-09-13T01:40:20.000+08:00
diff --git a/README.rst b/README.rst
@@ -10,7 +10,7 @@ python-proxy
 .. |Hit-Count| image:: http://hits.dwyl.io/qwj/python-proxy.svg
    :target: https://pypi.python.org/pypi/pproxy/
 
-HTTP/Socks4/Socks5/Shadowsocks/ShadowsocksR/Redirect asynchronous tunnel proxy implemented in Python3 asyncio.
+HTTP/Socks4/Socks5/Shadowsocks/ShadowsocksR/Redirect/Pf asynchronous tunnel proxy implemented in Python3 asyncio.
 
 QuickStart
 ----------
@@ -138,6 +138,35 @@ Usage
   
   Online help: <https://github.com/qwj/python-proxy>
 
+Protocols
+---------
+
++-------------------+------------+-----------+-------------+
+| Name              | server     | client    | scheme      |
++===================+============+===========+=============+
+| http (connect)    | ✔          | ✔         | http://     |
++-------------------+------------+-----------+-------------+
+| http (get,post)   | ✔          | ✖         | http://     |
++-------------------+------------+-----------+-------------+
+| https             | ✔          | ✔         | http+ssl:// |
++-------------------+------------+-----------+-------------+
+| socks4            | ✔          | ✔         | socks4://   |
++-------------------+------------+-----------+-------------+
+| socks5            | ✔          | ✔         | socks5://   |
++-------------------+------------+-----------+-------------+
+| shadowsocks       | ✔          | ✔         | ss://       |
++-------------------+------------+-----------+-------------+
+| shadowsocks aead  | ✔          | ✔         | ss://       |
++-------------------+------------+-----------+-------------+
+| shadowsocksR      | ✔          | ✔         | ssr://      |
++-------------------+------------+-----------+-------------+
+| iptables nat      | ✔          |           | redir://    |
++-------------------+------------+-----------+-------------+
+| pfctl nat (macos) | ✔          |           | pf://       |
++-------------------+------------+-----------+-------------+
+| AUTO DETECT       | ✔          |           | a+b+c+d://  |
++-------------------+------------+-----------+-------------+
+
 URI Syntax
 ----------
 
@@ -162,6 +191,8 @@ URI Syntax
     +--------+-----------------------------+
     | redir  | redirect (iptables nat)     |
     +--------+-----------------------------+
+    | pf     | pfctl (macos pf nat)        |
+    +--------+-----------------------------+
     | ssl    | unsecured ssl/tls (no cert) |
     +--------+-----------------------------+
     | secure | secured ssl/tls (cert)      |
@@ -387,9 +418,9 @@ Examples
 
     $ 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
 
-- Redirect protocol
+- Redirect/Pf protocol
 
-  IPtable NAT redirect example:
+  IPTable NAT redirect example (Ubuntu):
 
   .. code:: rst
 
@@ -398,6 +429,18 @@ Examples
 
   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.
 
+  PF redirect example (MacOS):
+
+  .. code:: rst
+
+    $ sudo pfctl -ef /dev/stdin
+    rdr pass on lo0 inet proto tcp from any to any port 80 -> 127.0.0.1 port 8080
+    pass out on en0 route-to lo0 inet proto tcp from any to any port 80 keep state
+    ^D
+    $ sudo pproxy -i pf://:8080 -r socks5://remote_socks5_server:1324 -v
+
+  Make sure **pproxy** runs in root mode (sudo), otherwise it cannot redirect pf packet.
+
 - Relay tunnel
 
   Relay tunnel example:
diff --git a/setup.py b/setup.py
@@ -34,9 +34,10 @@ def find_version(*file_paths):
         'Topic :: Software Development :: Build Tools',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
     ],
-    keywords='proxy socks http shadowsocks redirect tunnel cipher ssl',
+    keywords='proxy socks http shadowsocks shadowsocksr ssr redirect tunnel cipher ssl',
     packages=['pproxy'],
     extras_require={
         'accelerated': [
