https://github.com/matt-snider/socks5
A socks5 server in python using asyncio
https://github.com/matt-snider/socks5
Last synced: 3 months ago
JSON representation
A socks5 server in python using asyncio
- Host: GitHub
- URL: https://github.com/matt-snider/socks5
- Owner: matt-snider
- Created: 2016-09-12T21:37:33.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-28T12:30:51.000Z (about 7 years ago)
- Last Synced: 2025-04-04T13:12:38.276Z (3 months ago)
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# socks5
A socks5 server in Python using asyncio.
Works with python >= 3.6
# Installation
This package is available on [pypi](https://pypi.org/project/socks5server/)
Install it with pip:
```sh
$ 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:
```txt
:[:]
```