fast-socks5
| Crates.io | fast-socks5 |
| lib.rs | fast-socks5 |
| version | |
| source | src |
| created_at | 2020-01-13 09:55:04.422205 |
| updated_at | 2025-02-06 08:11:48.706362 |
| description | Fast SOCKS5 client/server implementation written in Rust async/.await (tokio) |
| homepage | |
| repository | https://github.com/dizda/fast-socks5 |
| max_upload_size | |
| id | 198029 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Jonathan Dizdarevic (dizda)
documentation
README
SOCKS5 client/server library using async/.await
This library is maintained by anyip.io a residential and mobile socks5 proxy provider.
Features
-
An
async/.awaitSOCKS5 implementation. -
An
async/.awaitSOCKS4 Client implementation. -
An
async/.awaitSOCKS4a Client implementation. -
No unsafe code
-
Built on top of the Tokio runtime
-
Ultra lightweight and scalable
-
No system dependencies
-
Cross-platform
-
Infinitely extensible, explicit server API based on typestates for safety
- You control the request handling, the library only ensures you follow the proper protocol flow
- Can skip DNS resolution
- Can skip the authentication/handshake process (not RFC-compliant, for private use, to save on useless round-trips)
- Instead of proxying in-process, swap out
run_tcp_proxyfor custom handling to build a router or to use a custom accelerated proxying method
-
Authentication methods:
- No-Auth method (
0x00) - Username/Password auth method (
0x02) - Custom auth methods can be implemented on the server side via the
AuthMethodTrait- Multiple auth methods with runtime negotiation can be supported, with fast static dispatch (enums can be generated with the
auth_method_enumsmacro)
- Multiple auth methods with runtime negotiation can be supported, with fast static dispatch (enums can be generated with the
- No-Auth method (
-
UDP is supported
-
All SOCKS5 RFC errors (replies) should be mapped
-
IPv4,IPv6, andDomainstypes are supported
Install
Open in crates.io.
Examples
Please check examples directory.
# Run client
RUST_LOG=debug cargo run --example client -- --socks-server 127.0.0.1:1337 --username admin --password password -a perdu.com -p 80
# Run server
RUST_LOG=debug cargo run --example server -- --listen-addr 127.0.0.1:1337 password -u admin -p password
# Test it with cURL
curl -v --proxy socks5://admin:password@127.0.0.1:1337 https://ipapi.co/json/
TODO
- Tests have to be implemented
- Better Rust doc
Inspired by
Thanks to all these SOCKS5 projects
- https://github.com/sfackler/rust-socks/blob/master/src/v5.rs
- https://github.com/shadowsocks/shadowsocks-rust/blob/master/src/relay/socks5.rs
- https://github.com/ylxdzsw/v2socks/blob/master/src/socks.rs
Further consideration
- Implementation made with Tokio-codec https://github.com/yfaming/yimu-rs/blob/master/src/socks5.rs