Metadata-Version: 1.1
Name: twunnel
Version: 0.1.0
Summary: A HTTP/SOCKS5 tunnel for Twisted.
Home-page: https://github.com/jvansteirteghem/twunnel
Author: Jeroen Van Steirteghem
Author-email: jeroen.vansteirteghem@gmail.com
License: MIT
Description: Twunnel
        =======
        
        A HTTP/SOCKS5 tunnel for Twisted.
        
        Supports:
        
        - HTTP
        - HTTP + Basic authentication
        - SOCKS5
        
        Usage
        -----
        
        .. code:: python
        
            import twunnel
        
            protocolFactory = ..
        
            configuration = \
            {
            }
        
            tunnel = twunnel.Tunnel(configuration)
            tunnel.connect("www.google.com", 80, protocolFactory)
        
        .. code:: python
        
            from twisted.internet import ssl
            import twunnel
        
            protocolFactory = ..
        
            configuration = \
            {
            }
        
            contextFactory = ssl.ClientContextFactory()
        
            tunnel = twunnel.Tunnel(configuration)
            tunnel.connect("www.google.com", 443, protocolFactory, contextFactory)
        
        .. code:: python
        
            import twunnel
        
            protocolFactory = ..
        
            configuration = \
            {
                "PROXY_SERVERS": 
                [
                    {
                        "TYPE": "HTTP",
                        "ADDRESS": "127.0.0.1",
                        "PORT": 8080,
                        "AUTHENTICATION": 
                        {
                            "USERNAME": "1",
                            "PASSWORD": "2"
                        }
                    }
                ]
            }
        
            tunnel = twunnel.Tunnel(configuration)
            tunnel.connect("www.google.com", 80, protocolFactory)
        
        .. code:: python
        
            import twunnel
        
            protocolFactory = ..
        
            configuration = \
            {
                "PROXY_SERVERS": 
                [
                    {
                        "TYPE": "SOCKS5",
                        "ADDRESS": "127.0.0.1",
                        "PORT": 1080
                    }
                ]
            }
        
            tunnel = twunnel.Tunnel(configuration)
            tunnel.connect("www.google.com", 80, protocolFactory)
        
        .. code:: python
        
            import twunnel
        
            protocolFactory = ..
        
            configuration = \
            {
                "PROXY_SERVERS": 
                [
                    {
                        "TYPE": "HTTP",
                        "ADDRESS": "127.0.0.1",
                        "PORT": 8080,
                        "AUTHENTICATION": 
                        {
                            "USERNAME": "1",
                            "PASSWORD": "2"
                        }
                    },
                    {
                        "TYPE": "SOCKS5",
                        "ADDRESS": "127.0.0.1",
                        "PORT": 1080
                    }
                ]
            }
        
            tunnel = twunnel.Tunnel(configuration)
            tunnel.connect("www.google.com", 80, protocolFactory)
        
        License
        -------
        
        Uses the `MIT`_ license.
        
        
        .. _MIT: http://opensource.org/licenses/MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Twisted
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
