python-socks 2.4.0__py3-none-any.whl → 2.4.2__py3-none-any.whl

python_socks/_protocols/socks5.py

@@ -190,6 +190,9 @@ class ConnectReply:
 
     @classmethod
     def loads(cls, data: bytes) -> 'ConnectReply':
+        if not data:
+            raise ReplyError('Empty connect reply')
+
         ver = data[0]
         if ver != SOCKS_VER:  # pragma: no cover
             raise ReplyError(f'Unexpected SOCKS version number: {ver:#02X}')

python_socks/_version.py

@@ -1,2 +1,2 @@
 __title__ = 'python-socks'
-__version__ = '2.4.0'
+__version__ = '2.4.2'

python_socks-2.4.2.dist-info/METADATA

@@ -0,0 +1,276 @@
+Metadata-Version: 2.1
+Name: python-socks
+Version: 2.4.2
+Summary: Core proxy (SOCKS4, SOCKS5, HTTP tunneling) functionality for Python
+Home-page: https://github.com/romis2012/python-socks
+Author: Roman Snegirev
+Author-email: snegiryev@gmail.com
+License: Apache 2
+Keywords: socks socks5 socks4 http proxy asyncio trio curio anyio
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: anyio
+Requires-Dist: anyio (<4.0.0,>=3.3.4) ; extra == 'anyio'
+Provides-Extra: asyncio
+Requires-Dist: async-timeout (>=3.0.1) ; extra == 'asyncio'
+Provides-Extra: curio
+Requires-Dist: curio (>=1.4) ; extra == 'curio'
+Provides-Extra: trio
+Requires-Dist: trio (>=0.16.0) ; extra == 'trio'
+
+## python-socks
+
+[![Build Status](https://api.travis-ci.com/romis2012/python-socks.svg?branch=master)](https://travis-ci.com/github/romis2012/python-socks)
+[![Coverage Status](https://coveralls.io/repos/github/romis2012/python-socks/badge.svg?branch=master&_=q)](https://coveralls.io/github/romis2012/python-socks?branch=master)
+[![PyPI version](https://badge.fury.io/py/python-socks.svg)](https://badge.fury.io/py/python-socks)
+<!--
+[![Downloads](https://pepy.tech/badge/python-socks/month)](https://pepy.tech/project/python-socks)
+-->
+
+The `python-socks` package provides a core proxy client functionality for Python.
+Supports SOCKS4(a), SOCKS5(h), HTTP (tunneling) proxy and provides sync and async (asyncio, trio, curio, anyio) APIs.
+You probably don't need to use `python-socks` directly. 
+It is used internally by 
+[aiohttp-socks](https://github.com/romis2012/aiohttp-socks) and [httpx-socks](https://github.com/romis2012/httpx-socks) packages.  
+
+## Requirements
+- Python >= 3.6
+- async-timeout >= 3.0.1 (optional)
+- trio >= 0.16.0 (optional)
+- curio >= 1.4 (optional)
+- anyio >= 3.3.4 (optional)
+
+## Installation
+
+only sync proxy support:
+```
+pip install python-socks
+```
+
+to include optional asyncio support:
+```
+pip install python-socks[asyncio]
+```
+
+to include optional trio support:
+```
+pip install python-socks[trio]
+```
+
+to include optional curio support:
+```
+pip install python-socks[curio]
+```
+
+to include optional anyio support:
+```
+pip install python-socks[anyio]
+```
+
+## Simple usage
+We are making secure HTTP GET request via SOCKS5 proxy
+ 
+#### Sync
+```python
+import ssl
+from python_socks.sync import Proxy
+
+proxy = Proxy.from_url('socks5://user:password@127.0.0.1:1080')
+
+# `connect` returns standard Python socket in blocking mode
+sock = proxy.connect(dest_host='check-host.net', dest_port=443)
+
+sock = ssl.create_default_context().wrap_socket(
+    sock=sock,
+    server_hostname='check-host.net'
+)
+
+request = (
+    b'GET /ip HTTP/1.1\r\n'
+    b'Host: check-host.net\r\n'
+    b'Connection: close\r\n\r\n'
+)
+sock.sendall(request)
+response = sock.recv(4096)
+print(response)
+```
+
+#### Async (asyncio)
+```python
+import ssl
+import asyncio
+from python_socks.async_.asyncio import Proxy
+
+proxy = Proxy.from_url('socks5://user:password@127.0.0.1:1080')
+
+# `connect` returns standard Python socket in non-blocking mode 
+# so we can pass it to asyncio.open_connection(...)
+sock = await proxy.connect(dest_host='check-host.net', dest_port=443)
+
+reader, writer = await asyncio.open_connection(
+    host=None,
+    port=None,
+    sock=sock,
+    ssl=ssl.create_default_context(),
+    server_hostname='check-host.net',
+)
+
+request = (
+    b'GET /ip HTTP/1.1\r\n'
+    b'Host: check-host.net\r\n'
+    b'Connection: close\r\n\r\n'
+)
+
+writer.write(request)
+response = await reader.read(-1)
+print(response)
+```
+
+#### Async (trio)
+```python
+import ssl
+import trio
+from python_socks.async_.trio import Proxy
+
+proxy = Proxy.from_url('socks5://user:password@127.0.0.1:1080')
+
+# `connect` returns trio socket 
+# so we can pass it to trio.SocketStream
+sock = await proxy.connect(dest_host='check-host.net', dest_port=443)
+
+stream = trio.SocketStream(sock)
+
+stream = trio.SSLStream(
+    stream, ssl.create_default_context(),
+    server_hostname='check-host.net'
+)
+await stream.do_handshake()
+
+request = (
+    b'GET /ip HTTP/1.1\r\n'
+    b'Host: check-host.net\r\n'
+    b'Connection: close\r\n\r\n'
+)
+
+await stream.send_all(request)
+response = await stream.receive_some(4096)
+print(response)
+```
+
+#### Async (curio)
+```python
+import curio.ssl as curiossl
+from python_socks.async_.curio import Proxy
+
+proxy = Proxy.from_url('socks5://user:password@127.0.0.1:1080')
+# `connect` returns curio.io.Socket
+sock = await proxy.connect(
+    dest_host='check-host.net',
+    dest_port=443
+)
+
+request = (
+    b'GET /ip HTTP/1.1\r\n'
+    b'Host: check-host.net\r\n'
+    b'Connection: close\r\n\r\n'
+)
+
+ssl_context = curiossl.create_default_context()
+sock = await ssl_context.wrap_socket(
+    sock, do_handshake_on_connect=False, server_hostname='check-host.net'
+)
+
+await sock.do_handshake()
+
+stream = sock.as_stream()
+
+await stream.write(request)
+response = await stream.read(1024)
+print(response)
+```
+
+#### Async (anyio)
+```python
+import ssl
+from python_socks.async_.anyio import Proxy
+
+proxy = Proxy.from_url('socks5://user:password@127.0.0.1:1080')
+
+# `connect` returns AnyioSocketStream
+stream = await proxy.connect(
+    dest_host='check-host.net',
+    dest_port=443,
+    dest_ssl=ssl.create_default_context(),
+)
+
+request = (
+    b'GET /ip HTTP/1.1\r\n'
+    b'Host: check-host.net\r\n'
+    b'Connection: close\r\n\r\n'
+)
+
+await stream.write_all(request)
+response = await stream.read()
+print(response)
+```
+
+## More complex example
+
+#### A urllib3 PoolManager that routes connections via the proxy
+
+```python
+from urllib3 import PoolManager, HTTPConnectionPool, HTTPSConnectionPool
+from urllib3.connection import HTTPConnection, HTTPSConnection
+from python_socks.sync import Proxy
+
+
+class ProxyHTTPConnection(HTTPConnection):
+    def __init__(self, *args, **kwargs):
+        socks_options = kwargs.pop('_socks_options')
+        self._proxy_url = socks_options['proxy_url']
+        super().__init__(*args, **kwargs)
+
+    def _new_conn(self):
+        proxy = Proxy.from_url(self._proxy_url)
+        return proxy.connect(
+            dest_host=self.host,
+            dest_port=self.port,
+            timeout=self.timeout
+        )
+
+
+class ProxyHTTPSConnection(ProxyHTTPConnection, HTTPSConnection):
+    pass
+
+
+class ProxyHTTPConnectionPool(HTTPConnectionPool):
+    ConnectionCls = ProxyHTTPConnection
+
+
+class ProxyHTTPSConnectionPool(HTTPSConnectionPool):
+    ConnectionCls = ProxyHTTPSConnection
+
+
+class ProxyPoolManager(PoolManager):
+    def __init__(self, proxy_url, timeout=5, num_pools=10, headers=None,
+                 **connection_pool_kw):
+
+        connection_pool_kw['_socks_options'] = {'proxy_url': proxy_url}
+        connection_pool_kw['timeout'] = timeout
+
+        super().__init__(num_pools, headers, **connection_pool_kw)
+
+        self.pool_classes_by_scheme = {
+            'http': ProxyHTTPConnectionPool,
+            'https': ProxyHTTPSConnectionPool,
+        }
+
+
+### and how to use it
+manager = ProxyPoolManager('socks5://user:password@127.0.0.1:1080')
+response = manager.request('GET', 'https://check-host.net/ip')
+print(response.data)
+```
+
+

{python_socks-2.4.0.dist-info → python_socks-2.4.2.dist-info}/RECORD

@@ -4,7 +4,7 @@ python_socks/_basic_auth.py,sha256=dnPOtNi6lMer0O0TRrsfZK1XA4oATrMftuWK9x8pMio,2
 python_socks/_errors.py,sha256=l2j03Zna_EJhNqF3yApTYuQ147BcY0k74pkT4HAlRp4,245
 python_socks/_helpers.py,sha256=WTqOACKhJ80bCLWqeoXHPKp6YWCg66vLtai5AM7HJNY,2517
 python_socks/_types.py,sha256=dgQifNf2mIwdKoX7YmI91H_lUsW9-Y0ZkZGlIV6_NNw,90
-python_socks/_version.py,sha256=XIvN1unDd0VFwrIxwk2rAoYKc8oqKLYNyYA5q8oF3jE,49
+python_socks/_version.py,sha256=ysF0_DwtAVl6cSBXA-tZ7JUWoNPo03_rmz-qVSq_D7M,49
 python_socks/_connectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 python_socks/_connectors/abc.py,sha256=1fgjPiv64UAMiJDsJXYr-GofPGhuHTwTzaodQfrzf7Q,397
 python_socks/_connectors/factory_async.py,sha256=y9JGVk-ub9FMuQlIp2s5y95F7JMvA2fEdWGRKLUpRXc,997
@@ -19,7 +19,7 @@ python_socks/_protocols/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 python_socks/_protocols/errors.py,sha256=4XqU4AqgrWaedmUVGMjd6TvQKXv3mV0H76s5lf8aazY,150
 python_socks/_protocols/http.py,sha256=C6lCkGzpbNWHQWi6ftXHhS85VPw9-Jik_igcXkzTbng,2406
 python_socks/_protocols/socks4.py,sha256=QlWtGaPIa0jUfHreHIXZalHM9q4GQ684h7JSvxFwiJI,3023
-python_socks/_protocols/socks5.py,sha256=IpfStfKrOHEvlg-gaEi5CntSIUIumqmWlHAVlbrTAuM,9334
+python_socks/_protocols/socks5.py,sha256=2W-x_6UAjjfH_7g90Ke6-pQFnJjBN-PDBFxRoWdoo7A,9408
 python_socks/async_/__init__.py,sha256=TeBn5oirLy6aPoWcTc3OW9OxXh5Uv5LADwF_Y7f7HjY,64
 python_socks/async_/_proxy_chain.py,sha256=A2LbxoRBgdHSikVJcrOAVDx79DT5Isq3RM_DiHTI8dM,824
 python_socks/async_/anyio/__init__.py,sha256=pZnrND4Qd-pIGg7KI1ML41kZNkWHmkd3vrvwZZIJyk4,106
@@ -70,8 +70,8 @@ python_socks/sync/v2/_connect.py,sha256=eqMKsH2wVnGZhV24_t9QfsNhjbnKtnipj7wzSNct
 python_socks/sync/v2/_proxy.py,sha256=B2phFTScHW7SZxnn2Vspc9fHof6GVJhW9BGuJ6S7Sa8,3396
 python_socks/sync/v2/_ssl_transport.py,sha256=MURwzvKu-S2-MI7o8KaZTvvBFOiiKIu5R0ERVIMvERE,6088
 python_socks/sync/v2/_stream.py,sha256=Jq89x1xmIX3L_v-WyS1nRTItjTnYTcDcfDblsANxfJI,1544
-python_socks-2.4.0.dist-info/LICENSE.txt,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-python_socks-2.4.0.dist-info/METADATA,sha256=FpkHdrBIvDG9dVhpW_6VC--laXI3zOnxpK68ICeQL4s,723
-python_socks-2.4.0.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
-python_socks-2.4.0.dist-info/top_level.txt,sha256=7qyDAVwjTZ0sIYG1iatFbE-SLpWhONjaoMQ0Ib2DX0Q,13
-python_socks-2.4.0.dist-info/RECORD,,
+python_socks-2.4.2.dist-info/LICENSE.txt,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+python_socks-2.4.2.dist-info/METADATA,sha256=QNpy0n8oY--GCJ5uwziT1L8uKJHmYsORibIKyvHzEs8,7057
+python_socks-2.4.2.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
+python_socks-2.4.2.dist-info/top_level.txt,sha256=7qyDAVwjTZ0sIYG1iatFbE-SLpWhONjaoMQ0Ib2DX0Q,13
+python_socks-2.4.2.dist-info/RECORD,,

python_socks-2.4.0.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: python-socks
-Version: 2.4.0
-Summary: Core proxy (SOCKS4, SOCKS5, HTTP tunneling) functionality for Python
-Home-page: https://github.com/romis2012/python-socks
-Author: Roman Snegirev
-Author-email: snegiryev@gmail.com
-License: Apache 2
-Keywords: socks socks5 socks4 http proxy asyncio trio curio anyio
-Platform: UNKNOWN
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Provides-Extra: anyio
-Requires-Dist: anyio (<4.0.0,>=3.3.4) ; extra == 'anyio'
-Provides-Extra: asyncio
-Requires-Dist: async-timeout (>=3.0.1) ; extra == 'asyncio'
-Provides-Extra: curio
-Requires-Dist: curio (>=1.4) ; extra == 'curio'
-Provides-Extra: trio
-Requires-Dist: trio (>=0.16.0) ; extra == 'trio'
-
-2.4.0
-