Metadata-Version: 2.1
Name: shadowproxy
Version: 0.5.0
Summary: A proxy server that implements Socks5/Shadowsocks/Redirect/HTTP (tcp) and Shadowsocks/TProxy/Tunnel (udp) protocols.
Home-page: https://github.com/guyingbo/shadowproxy
Author: Yingbo Gu
Author-email: tensiongyb@gmail.com
Maintainer: Yingbo Gu
Maintainer-email: tensiongyb@gmail.com
License: MIT
Description: # Shadowproxy
        
        [![Build Status](https://travis-ci.org/guyingbo/shadowproxy.svg?branch=master)](https://travis-ci.org/guyingbo/shadowproxy)
        [![Python Version](https://img.shields.io/pypi/pyversions/shadowproxy.svg)](https://pypi.python.org/pypi/shadowproxy)
        [![Version](https://img.shields.io/pypi/v/shadowproxy.svg)](https://pypi.python.org/pypi/shadowproxy)
        [![Format](https://img.shields.io/pypi/format/shadowproxy.svg)](https://pypi.python.org/pypi/shadowproxy)
        [![License](https://img.shields.io/pypi/l/shadowproxy.svg)](https://pypi.python.org/pypi/shadowproxy)
        [![Code Coverage](https://codecov.io/gh/guyingbo/shadowproxy/branch/master/graph/badge.svg)](https://codecov.io/gh/guyingbo/shadowproxy)
        [![Lines Of Code](https://tokei.rs/b1/github/guyingbo/shadowproxy?category=code)](https://github.com/guyingbo/shadowproxy)
        
        
        ## Introduction
        
        A proxy server that implements Socks5/Shadowsocks/Redirect/HTTP (tcp) and Shadowsocks/TProxy/Tunnel (udp) protocols.
        
        Thanks to Dabeaz's awesome curio project: https://github.com/dabeaz/curio
        
        This project is inspired by qwj's python-proxy project(https://github.com/qwj/python-proxy).
        
        It is a replacement of shadowsocks and shadowsocks-libev, you can replace ss-redir, ss-tunnel, ss-server, ss-local with just one shadowproxy command.
        
        ## Installation
        
        shadowproxy requires Python3.6+
        
        ```
        pip install shadowproxy
        ```
        
        ## Features
        
        ### supported protocols
        
        protocol | server | client | scheme
        --- | --- | --- | ---
        socks5 | ✓ | ✓ | socks://
        socks4 | ✓ | ✓ | socks4://
        ss | ✓ | ✓ | ss://
        ss aead | ✓ | ✓ | ss://
        http | ✓ | ✓ | httponly://
        http connect | ✓ | ✓ | http://
        transparent proxy | ✓ | | red://
        tunnel(udp) | ✓ | | tunneludp://
        ss(udp) | ✓ | ✓ | ssudp://
        
        ### supported plugins
        
        plugin | server | client
        --- | --- | ---
        http_simple | ✓ | ✓
        tls1.2_ticket_auth | ✓ | ✓
        
        ### supported ciphers
        
        * aes-256-cfb
        * aes-128-cfb
        * aes-192-cfb
        * chacha20
        * salsa20
        * rc4
        * aes-256-gcm
        * aes-192-gcm
        * aes-128-gcm
        
        ## Usage
        
        ```
        usage: shadowproxy [-h] [-v] [--version] [--monitor] server [server ...]
        
        uri syntax:
        
        {scheme}://[{userinfo}@][hostname]:{port}[/?[plugin={p;args}][via={uri}][target={t}]][#{fragment}]
        
        userinfo = cipher:password or base64(cipher:password) when scheme is ss, ssudp
        userinfo = username:password or base64(username:password) when scheme is socks, http.
        
        ```
        
        examples:
        
        ```
        # socks5 --> shadowsocks
        shadowproxy -v socks://:8527/?via=ss://aes-256-cfb:password@127.0.0.1:8888
        
        # http   --> shadowsocks
        shadowproxy -v http://:8527/?via=ss://aes-256-cfb:password@127.0.0.1:8888
        
        # redir  --> shadowsocks
        shadowproxy -v red://:12345/?via=ss://aes-256-cfb:password@127.0.0.1:8888
        
        # shadowsocks server (tcp)
        shadowproxy -v ss://aes-256-cfb:password@:8888
        
        # shadowsocks server (udp)
        shadowproxy -v ssudp://aes-256-cfb:password@:8527
        
        # tunnel --> shadowsocks (udp)
        shadowproxy -v tunneludp://:8527/?target=8.8.8.8:53&via=ssudp://aes-256-cfb:password@127.0.0.1:8888
        
        # tproxy --> shadowsocks (udp)
        shadowproxy -v tproxyudp://:8527/?via=ssudp://aes-256-cfb:password@127.0.0.1:8888
        ```
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
