YGGverse/psocks
1
0
Fork 0
mirror of https://codeberg.org/YGGverse/psocks.git synced 2026-03-31 16:35:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Filtering asynchronous SOCKS5 (TCP/UDP) proxy server https://crates.io/crates/psocks
17 commits 1 branch 0 tags 175 KiB
Find a file
postscriptum b5d0742ca7 describe primary goals
2026-03-22 20:02:17 +02:00
src handle http errors 2026-03-22 12:42:24 +02:00
.gitignore initial commit 2026-03-22 01:06:24 +02:00
Cargo.lock update version 2026-03-22 13:21:06 +02:00
Cargo.toml update version 2026-03-22 13:21:06 +02:00
LICENSE Initial commit 2026-03-22 00:02:29 +01:00
README.md describe primary goals 2026-03-22 20:02:17 +02:00

README.md

psocks

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

Goals

  • Ad/tracking protection
  • Reduce CPU usage by filtering extra SSL traffic on background

Roadmap

  • Web JSON/API
    • Block stats
    • In-memory list update (without server restart)
      • Persist changes option (see -c, --cache)
  • Web UI
  • Performance optimization

Usage

RUST_LOG=trace cargo run -- -a=http://localhost/allow.txt \
                            -a=/path/to/allow.txt \
                            -c=/path/to/cache.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:
    • /allow/domain.com - add rule to the current session
    • /block/domain.com - delete rule from the current session

Allow list example

# /path/to/allow.txt

// exact match
duckduckgo.com

// google.com with subdomains
.google.com

// IP resolved
1.2.3.4

systemd

git clone https://codeberg.org/postscriptum/psocks.git
cd psocks
cargo build --release --locked
sudo install target/release/psocks /usr/local/bin
sudo useradd -s /usr/sbin/nologin -Mr psocks
sudo mkdir /var/lib/psocks && sudo chown psocks:psocks /var/lib/psocks
sudo mkdir /var/log/psocks && sudo chown psocks:psocks /var/log/psocks

#/etc/systemd/system/psocks.service

[Unit]
After=network-online.target
Wants=network-online.target

[Service]
User=psocks
Group=psocks

WorkingDirectory=/var/lib/psocks
ExecStart=/usr/local/bin/psocks \
              -a=https://codeberg.org/postscriptum/psocks-list/raw/branch/main/allow/internet.txt \
              -c=/var/lib/psocks/cache.txt \
              no-auth

Restart=always

Environment="RUST_LOG=psocks=warn"
Environment="NO_COLOR=1"

StandardOutput=file:///var/log/psocks/debug.log
StandardError=file:///var/log/psocks/error.log

[Install]
WantedBy=multi-user.target
  • sudo systemctl restart psocks
  • sudo systemctl enable psocks
  • sudo systemctl status psocks