psocks/README.md

psocks

Experimental async SOCKS5 (TCP/UDP) proxy server based on fast-socks5, featuring allowlist-based access control (drop everything but allowed by user) with JSON/API based on Rocket framework.

Roadmap

• Range support
• Local Web-API
  • Block stats
  • In-memory list update (without server restart)
    • Persist changes option
  • Performance optimization

Usage

RUST_LOG=psocks=trace cargo run -- -a=/path/to/allow1.txt \
                                   -a=http://localhost/allow2.txt \
                                   no-auth

• set socks5://127.0.0.1:1080 proxy in your application
• open http://127.0.0.1:8010 in browser for global stats:
  • http://127.0.0.1:8010/allow/domain.com - add rule to the current session
  • http://127.0.0.1:8010/block/domain.com - delete rule from the current session

Allow list example

# /path/to/allow1.txt

// exact match
duckduckgo.com

// google.com with subdomains
.google.com

// IP resolved
1.2.3.4

• see also: my personal asset