farinholt/pysocks

A SOCKS server and client package built with asyncio.

pysocks

This is a SOCKS server and client package built with asyncio (requires Python 3.5+).

Installation

$ pip3 install git+https://github.com/gera2ld/pysocks.git

Usage

• SOCKS server

  shell command:

  # Start a server
  $ python3 -m socks.server -p 1081

  or python script:

  from socks.server import Config, serve
  
  config = Config()
  config.port = 1081
  serve(config)

• SOCKS client

  import asyncio
  from socks.client import SOCKS5Client
  
  client = SOCKS5Client(('127.0.0.1', 1080))
  client.handle_connect(('www.google.com', 80))
  client.writer.write(b'...')
  loop = asyncio.get_event_loop()
  loop.run_until_complete(client.reader.read())

• SOCKS handler for urllib

  from urllib import request
  from socks.client.handler import SOCKSProxyHandler
  
  # SOCKSProxyHandler may have parameters below
  # - version: 4 or 5
  # - proxy address: tuple(host, port)
  # - auth: tuple(user, password) or None
  handler = SOCKSProxyHandler(5, ('127.0.0.1', 1080))
  
  opener = request.build_opener(handler)
  r = opener.open('https://gerald.top')
  print(r.read().decode())