socks5_auth = aiosocks.Socks5Auth('login', 'pwd')
socks4_auth = aiosocks.Socks4Auth('ident')

dst = ('github.com', 80)

# socks5 connect
transport, protocol = await aiosocks.create_connection(
    lambda: Protocol, proxy=socks5_addr, proxy_auth=socks5_auth, dst=dst)

# socks4 connect
transport, protocol = await aiosocks.create_connection(
    lambda: Protocol, proxy=socks4_addr, proxy_auth=socks4_auth, dst=dst)
    
# socks4 without auth and local domain name resolving
transport, protocol = await aiosocks.create_connection(
    lambda: Protocol, proxy=socks4_addr, proxy_auth=None, dst=dst, remote_resolve=False)

# use socks protocol
transport, protocol = await aiosocks.create_connection(
    None, proxy=socks4_addr, proxy_auth=None, dst=dst)

if name == 'main': loop = asyncio.get_event_loop() loop.run_until_complete(connect()) loop.close()

A wrapper for create_connection() returning a (reader, writer) pair

.. code-block:: python

# StreamReader, StreamWriter
reader, writer = await aiosocks.open_connection(
    proxy=socks5_addr, proxy_auth=socks5_auth, dst=dst, remote_resolve=True)

data = await reader.read(10)
writer.write('data')

error handling ^^^^^^^^^^^^^^

SocksError is a base class for: - NoAcceptableAuthMethods - LoginAuthenticationFailed - InvalidServerVersion - InvalidServerReply

.. code-block:: python

try:
  transport, protocol = await aiosocks.create_connection(
      lambda: Protocol, proxy=socks5_addr, proxy_auth=socks5_auth, dst=dst)
except aiosocks.SocksConnectionError:
  # connection error
except aiosocks.LoginAuthenticationFailed:
  # auth failed
except aiosocks.NoAcceptableAuthMethods:
  # All offered SOCKS5 authentication methods were rejected
except (aiosocks.InvalidServerVersion, aiosocks.InvalidServerReply):
  # something wrong
except aiosocks.SocksError:
  # something other

.. code-block:: python

try:
  transport, protocol = await aiosocks.create_connection(
      lambda: Protocol, proxy=socks5_addr, proxy_auth=socks5_auth, dst=dst)
except aiosocks.SocksConnectionError:
    # connection error
except aiosocks.SocksError:
    # socks error

aiohttp usage ^^^^^^^^^^^^^

.. code-block:: python

import asyncio import aiohttp import aiosocks from aiosocks.connector import ProxyConnector, ProxyClientRequest

async def load_github_main(): auth5 = aiosocks.Socks5Auth('proxyuser1', password='pwd') auth4 = aiosocks.Socks4Auth('proxyuser1') ba = aiohttp.BasicAuth('login')

# remote resolve
conn = ProxyConnector(remote_resolve=True)

# or locale resolve
conn = ProxyConnector(remote_resolve=False)

try:
  with aiohttp.ClientSession(connector=conn, request_class=ProxyClientRequest) as session:
    # socks5 proxy
    async with session.get('http://github.com/', proxy='socks5://127.0.0.1:1080',
                           proxy_auth=auth5) as resp:
      if resp.status == 200:
        print(await resp.text())

    # socks4 proxy
    async with session.get('http://github.com/', proxy='socks4://127.0.0.1:1081',
                           proxy_auth=auth4) as resp:
      if resp.status == 200:
        print(await resp.text())

    # http proxy
    async with session.get('http://github.com/', proxy='http://127.0.0.1:8080',
                           proxy_auth=ba) as resp:
      if resp.status == 200:
        print(await resp.text())
except aiohttp.ClientProxyConnectionError:
  # connection problem
except aiohttp.ClientConnectorError:
  # ssl error, certificate error, etc
except aiosocks.SocksError:
  # communication problem

if name == 'main': loop = asyncio.get_event_loop() loop.run_until_complete(load_github_main()) loop.close()

FAQs

What is aiosocks?

Is aiosocks well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install