#proxy #socks #server

app koblas

Lightweight SOCKS5 proxy server

5 releases

0.1.4 Sep 11, 2023
0.1.3 Jul 15, 2023
0.1.2 Jun 17, 2023
0.1.1 May 18, 2023
0.1.0 Jan 21, 2023

#4 in #proxy-server

Download history 3/week @ 2023-06-10 25/week @ 2023-06-17 6/week @ 2023-06-24 13/week @ 2023-07-01 29/week @ 2023-07-15 9/week @ 2023-07-22 2/week @ 2023-07-29 8/week @ 2023-08-05 4/week @ 2023-08-12 1/week @ 2023-08-19 5/week @ 2023-08-26 5/week @ 2023-09-02 50/week @ 2023-09-09 6/week @ 2023-09-16

66 downloads per month

MIT/Apache

20KB
406 lines

Koblas

A lightweight SOCKS5 proxy server, written in Rust.

Installation

Cargo

Make sure the current stable release of Rust is installed.

Registry

cargo install koblas

Manual

git clone https://github.com/ynuwenhof/koblas.git
cd koblas
cargo install --path .

Hash passwords by running the following command:

koblas hash "correct-horse-battery-staple"

this will return an Argon2id password hash.

After installing, you can run the server with:

koblas -a 0.0.0.0 --auth -u /path/to/users.toml

this will bind the server to 0.0.0.0:1080.

Docker

Make sure the Docker Engine is installed.

Pull the latest image from the Docker Hub registry with:

docker pull ynuwenhof/koblas:latest

Run the following commands to build the image yourself instead:

git clone https://github.com/ynuwenhof/koblas.git
cd koblas
docker build -t ynuwenhof/koblas:latest .

Hash passwords by running the following command:

docker run -it --rm ynuwenhof/koblas:latest hash "correct-horse-battery-staple"

this will return an Argon2id password hash.

After pulling or building the image, you can run the server with:

docker run -d -p 1080:1080 \
  -v /path/to/users.toml:/etc/koblas/users.toml \
  -e RUST_LOG=debug \
  -e KOBLAS_NO_AUTHENTICATION=false \
  -e KOBLAS_ANONYMIZE=false \
  --name koblas ynuwenhof/koblas:latest

this will bind the server to 0.0.0.0:1080.

Configuration

Koblas can be configured via environment variables or command line arguments.

Missing keys will fall back to their default value.

Key Description Default
KOBLAS_ADDRESS Address on which to listen for incoming TCP connections 127.0.0.1
KOBLAS_PORT Port on which to listen for incoming TCP connections 1080
KOBLAS_LIMIT Maximum amount of clients to handle at once 255
KOBLAS_NO_AUTHENTICATION Don't require clients to authenticate using a username/password combination false
KOBLAS_ANONYMIZATION Exclude sensitive information from the logs false
KOBLAS_USERS_PATH File path to the list of existing users None

⚠️ The default configuration requires everyone to connect with a pre-existing username/password combination.

Koblas doesn't have a default users file location, but we recommend the following locations:

  • Linux: /etc/koblas/users.toml
  • MacOS: /etc/koblas/users.toml
  • Windows: %ProgramData%\koblas\users.toml

Example

[users]
# Username = "alice", password = "QDuMGlxdhpZt"
alice = "$argon2id$v=19$m=8,t=2,p=1$bWUwSXl2M2pYNU9xcVBocw$f4gFaE7p0qWRKw"
# Username = "bob", password = "ceQvWaDGVeTv"
bob = "$argon2id$v=19$m=8,t=2,p=1$ZExzaTM3aks1WjU1a3g4UA$J+EiueHYuR/dlA"

License

This project is licensed under either of the following licenses, at your option:

Dependencies

~11–23MB
~294K SLoC