Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 937 Bytes

README.md

File metadata and controls

44 lines (30 loc) · 937 Bytes
Raw

socks5

A socks5 server in Python using asyncio.

Works with python >= 3.6

Installation

This package is available on pypi

Install it with pip:

$ pip install socks5server

Requires: click, kaviar

Usage

$ socks5.server --help
Usage: socks5.server [OPTIONS]

  Runs a SOCK5 server.

Options:
  --host TEXT             The interfaces to listen on
  --port INTEGER          The port to listen on
  --allow-no-auth         Whether to allow clients that do not use
                          authentication
  --basic-auth-file PATH  File containing username/password combinations
  --help                  Show this message and exit.

Authentication

The only method currently supported is basic auth, which can be configured using the --basic-auth-file option. This should point to a file storing credentials in the format:

<username>:<password>[:<comment>]