rootandfactory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
0166fb6511
CI / cargo fmt (push) Has been cancelled
CI / cargo clippy (macos-latest) (push) Has been cancelled
CI / cargo clippy (ubuntu-latest) (push) Has been cancelled
CI / cargo clippy (windows-latest) (push) Has been cancelled
CI / cargo test (macos-latest) (push) Has been cancelled
CI / cargo test (ubuntu-latest) (push) Has been cancelled
CI / cargo test (windows-latest) (push) Has been cancelled
CI / cargo build (macos-latest) (push) Has been cancelled
CI / cargo build (ubuntu-latest) (push) Has been cancelled
CI / cargo build (windows-latest) (push) Has been cancelled
CI / cargo build --release (macos-latest) (push) Has been cancelled
CI / cargo build --release (ubuntu-latest) (push) Has been cancelled
CI / cargo build --release (windows-latest) (push) Has been cancelled
CI / CLI smoke (macos-latest) (push) Has been cancelled
CI / CLI smoke (ubuntu-latest) (push) Has been cancelled
CI / CLI smoke (windows-latest) (push) Has been cancelled
CI / Minimal E2E (macos-latest) (push) Has been cancelled
CI / Minimal E2E (ubuntu-latest) (push) Has been cancelled
CI / Minimal E2E (windows-latest) (push) Has been cancelled
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
2.1 KiB
2.1 KiB
Getting started
Prerequisites
- Rust 1.85+ (the project uses Edition 2024)
- A POSIX shell or PowerShell for running commands
- curl (for E2E testing)
Build
cd rustunnel
cargo build --release
The release binary is produced at target/release/rustunnel.
Run tests
cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo check
cargo test --all-targets
The test suite includes unit tests for framing, SOCKS5 parsing, TLS config building, credential generation, connection key roundtrips, and full end-to-end tunnel flows.
Generate credentials
./target/release/rustunnel generate --out ./creds
This creates:
creds/ca.pem— CA certificatecreds/ca.key— CA private keycreds/server.crt— server certificatecreds/server.key— server private keycreds/client.crt— client certificatecreds/client.key— client private keycreds/token.txt— auth tokencreds/config.json— configuration file with paths and defaults
Run a tunnel
Start the listener
./target/release/rustunnel listen \
--listen 127.0.0.1:4180 \
--cert ./creds/server.crt \
--key ./creds/server.key \
--ca-cert ./creds/ca.pem \
--auth-token-file ./creds/token.txt
Start the connector
./target/release/rustunnel connect \
--target 127.0.0.1:4180 \
--socks 127.0.0.1:1180 \
--cert ./creds/client.crt \
--key ./creds/client.key \
--ca-cert ./creds/ca.pem \
--auth-token-file ./creds/token.txt
Use the SOCKS5 proxy
curl --proxy socks5h://127.0.0.1:1180 http://127.0.0.1:4181/
Using a connection key
Instead of passing individual certificate paths, you can generate a single connection key:
./target/release/rustunnel keygen --target 127.0.0.1:4180
Then start the listener with the key (it auto-generates credentials):
./target/release/rustunnel listen --connection-key <key>
And connect with the same key:
./target/release/rustunnel connect <key>
Defaults
- Listener bind address:
0.0.0.0:4180 - Connector target: required (or taken from connection key)
- Connector SOCKS5 proxy:
127.0.0.1:1180